Skip to main content

Get data access information for an integration.

GEThttps://api.propexo.com/v1/admin/integrations/:integration_id/data-access

Authentication​

  • AuthorizationBearer
    Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters​

integration_id stringrequired

The Propexo unique identifier for the integration

Response​

Successful response

    result objectrequired
    models objectrequired
    property name* object
    read object
    anyOf
    statusstringrequired
    Show 3 enum values
    SUCCESSFAILEDPROCESSING
    error_messagestring | nullnullablerequired
    create object
    anyOf
    statusstringrequired
    Show 3 enum values
    SUCCESSFAILEDPROCESSING
    error_messagestring | nullnullablerequired
    update object
    anyOf
    statusstringrequired
    Show 3 enum values
    SUCCESSFAILEDPROCESSING
    error_messagestring | nullnullablerequired
    last_data_access_checkstring | nullnullablerequired
    data_access_check_in_processbooleanrequired

Errors​

  • 400Bad Request
      error objectrequired
      codestringrequired
      Example: invalid_request
      messagestringrequired
      Example: invalid request
      details object
      property name*any
      Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}
GET /v1/admin/integrations/:integration_id/data-access
curl https://api.propexo.com/v1/admin/integrations/:integration_id/data-access \
     -H "Authorization: Bearer <token>"
200 Successful response
{
  "result": {
    "models": {},
    "last_data_access_check": "string",
    "data_access_check_in_process": true
  }
}