---
openapi: 3.0.3
info:
  title: "Braze REST API \u2013 List data objects"
  description: |
    ## Prerequisites

    To use this endpoint, you need an [API key]({{site.baseurl}}/api/basics#rest-api-key-permissions) with `data_objects.read`.

    ## Rate limit

    This endpoint is in the Data Objects read bucket with a default limit of 1000 requests per minute.
  version: 1.0.0
  contact:
    name: Braze Support
    url: https://www.braze.com/docs/braze_support/
  license:
    name: Braze Documentation
    url: https://www.braze.com/docs/api/home/
servers:
- url: https://rest.iad-01.braze.com
  description: US-01
- url: https://rest.iad-02.braze.com
  description: US-02
- url: https://rest.iad-03.braze.com
  description: US-03
- url: https://rest.iad-04.braze.com
  description: US-04
- url: https://rest.iad-05.braze.com
  description: US-05
- url: https://rest.iad-06.braze.com
  description: US-06
- url: https://rest.iad-07.braze.com
  description: US-07
- url: https://rest.iad-08.braze.com
  description: US-08
- url: https://rest.us-10.braze.com
  description: US-10
- url: https://rest.fra-01.braze.eu
  description: EU-01
- url: https://rest.fra-02.braze.eu
  description: EU-02
- url: https://rest.au-01.braze.com
  description: AU-01
- url: https://rest.id-01.braze.com
  description: ID-01
- url: https://rest.jp-01.braze.com
  description: JP-01
- url: https://rest.kr-01.braze.com
  description: KR-01
security:
- BearerAuth: []
paths:
  /data_objects/objects/{type_name}:
    get:
      summary: List data objects
      operationId: get_data_objects_objects_type_name_get_list_data_objects
      parameters:
        - name: type_name
          in: path
          required: true
          description: Data object type machine name.
          schema:
            type: string
          example: account
        - name: search_term
          in: query
          required: false
          description: Substring filter on object identifier.
          schema:
            type: string
          example: acct
        - name: limit
          in: query
          required: false
          description: Page size. Default `100`. Values above `250` are treated as `250`. Values below `1` return a `400` error.
          schema:
            type: integer
            minimum: 1
            default: 100
          example: 100
        - name: offset
          in: query
          required: false
          description: Offset. Default `0`. Negative values are floored to `0`.
          schema:
            type: integer
            default: 0
          example: 0
      responses:
        "200":
          description: |
            The request succeeded and the response body includes a page of data objects. No action needed.

            The status code `200` could return the following response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataObjectsResponse'
              examples:
                success:
                  summary: Data objects
                  description: This example lists the `account` records matching the search term `acct`, returning the first page of results.
                  value:
                    items:
                      - type_name: account
                        object_id: acct-123
                        attributes:
                          name: Acme
                          industry: software
                    total_count: 1
                    has_more: false
                    next_offset: null
                    offset: 0
                    limit: 100
        "400":
          description: |
            Bad request. A value or field name in the request body, path, or query isn't valid UTF-8 or contains the null character. Remove the invalid characters. The `invalid_request` error names each affected field in `source` and doesn't include the value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_characters:
                  summary: Value isn't valid UTF-8
                  value:
                    errors:
                      - id: 3f0c7a52-9b1e-4d6a-8c2f-5e7b1a9d4c60
                        status_code: 400
                        error_code: invalid_request
                        message: type_name must be valid UTF-8
                        source:
                          path: type_name
        "404":
          description: |
            Not found. Type not found (`data-object-type-not-found`). Confirm `type_name` exists in the workspace and matches the machine name exactly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                type_not_found:
                  summary: Type not found
                  value:
                    errors:
                      - id: data-object-type-not-found
                        message: Data object type not found.
                        parameters:
                          - type_name
                        parameter_values:
                          - account
        "401":
          description: |
            Unauthorized. Missing or invalid REST API key. Verify the `Authorization` header uses `Bearer YOUR_REST_API_KEY` and that the key is active. Send the key to the correct [REST endpoint]({{site.baseurl}}/api/basics/#endpoints). For more causes, see [Errors and responses]({{site.baseurl}}/api/errors/#fatal-errors).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_api_key:
                  summary: Missing or invalid API key
                  value:
                    error: Error authenticating credentials
        "403":
          description: |
            Access denied. API key lacks permission or request is blocked by allowlist. Confirm the key has `data_objects.read` and that your source IP is on the key allowlist, if configured.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                access_denied:
                  summary: Missing permission
                  value:
                    error: You do not have permission to access this resource
                ip_not_allowlisted:
                  summary: Source IP not on the key allowlist
                  value:
                    error: IP address 203.0.113.10 is not whitelisted
        "429":
          description: |
            Too many requests. Rate limit exceeded. Retry after `X-RateLimit-Reset` and reduce request frequency. See [API rate limits]({{site.baseurl}}/api/api_limits/).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                over_rate_limit:
                  summary: Over rate limit
                  value:
                    errors:
                      - id: rate-limit-exceeded
                        message: You have exceeded your limit of 1000 requests per minute. Please contact your account executive to increase your limit. If you do not have their info, you may contact Braze directly at https://www.braze.com/contact/.
        5XX:
          description: |
            Internal server error. An unexpected error occurred on the Braze server. Retry with exponential backoff. If the error persists, contact [Support]({{site.baseurl}}/braze_support/).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: REST API key
      description: |
        REST API keys are created in the Braze dashboard at **Settings → APIs and
        Identifiers → API Keys**. The key must include the `data_objects.read` permission.
        Pass the key as `Authorization: Bearer YOUR_REST_API_KEY`.
  schemas:
    ListDataObjectsResponse:
      title: List data objects response
      type: object
      required: [items, total_count, has_more, offset, limit]
      properties:
        items:
          type: array
          description: List of data object records.
          items:
            $ref: '#/components/schemas/DataObject'
        total_count:
          type: integer
          description: Total number of matching records.
          example: 1
        has_more:
          type: boolean
          description: Whether another page of results is available.
          example: false
        next_offset:
          type: integer
          nullable: true
          description: Offset for the next page when `has_more` is `true`.
          example: null
        offset:
          type: integer
          description: Current page offset.
          example: 0
        limit:
          type: integer
          description: Page size used by the request.
          example: 100
    DataObject:
      title: Data object
      type: object
      description: Data object record.
      required: [type_name, object_id, attributes]
      properties:
        type_name:
          type: string
          description: Data object type machine name.
          example: account
        object_id:
          type: string
          description: Data object identifier.
          example: acct-123
        attributes:
          type: object
          additionalProperties: true
          description: Object attributes keyed by field name.
          example:
            name: Acme
            industry: software
    ErrorDetail:
      title: Error detail
      type: object
      properties:
        id:
          type: string
          description: Machine-readable error identifier, such as `data-object-not-found`.
        message:
          type: string
          description: Human-readable error message.
        parameters:
          type: array
          description: Names of the request parameters the error refers to.
          items:
            type: string
        parameter_values:
          type: array
          description: Values of those parameters in the request.
          items:
            type: string
        status_code:
          type: integer
          description: HTTP status code. Included with `invalid_request` errors.
          example: 400
        error_code:
          type: string
          description: Error code, such as `invalid_request`. When it's present, `id` is a unique identifier for this error occurrence.
          example: invalid_request
        source:
          title: Error source
          type: object
          description: The request field the error applies to. Included with `invalid_request` errors.
          properties:
            path:
              type: string
              description: Dot-separated path to the field, such as `attributes.name`, when one field is affected.
            paths:
              type: array
              description: Dot-separated paths to each field, when more than one field is affected.
              items:
                type: string
    ErrorResponse:
      title: Error
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.
        error:
          type: string
          description: Human-readable error message returned for authentication, permission, and some validation errors.
        errors:
          type: array
          description: Optional list of detailed validation errors.
          items:
            $ref: '#/components/schemas/ErrorDetail'
