Retrieve attributes for the organization from a single bucket

Retrieve attributes for the organization from a single attribute bucket. The bucket must exist and must be accessible by the organization identified in the request header. If no attribute names are specified, all attributes in the bucket will be retrieved. Attribute names can be provided as a comma-separated list in the attributes query parameter. Empty attribute names are not permitted.

Path Parameters

bucket_name string required
The name of an attribute bucket. The bucket end_user_read_write exists for all organizations and is suitable for many common use cases. Please refer to our documentation for more information on attribute buckets.

Query Parameters

attributes string[]
A comma-separated list of attribute names
Example: address_line_1,address_line_2,city,zip_code

Header Parameters

SlashID-OrgID string required
The organization ID
Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1

Responses

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
errors object[]
httpcode integer
message string
result object
Clear-text person attributes as key-value pairs. Attribute names (keys) may be at most 70 bytes long. Attribute values must be JSON-serializable and are limited to 64KiB.

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ],
  "result": {}
}

Bad Request

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Forbidden

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Not Found

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Retrieve attributes for the organization from a single bucket​

Retrieve attributes for the organization from a single bucket