List user relationship types

Use this endpoint to list valid rel_kind values for user relationships on a data object type.

important

Data Objects is currently in early access. Your workspace must be enabled before the Data Objects API key permissions appear on Settings > API Keys.

Prerequisites

To use this endpoint, you need an API key with data_objects.read.

Rate limit

This endpoint is in the Data Objects read bucket with a default limit of 50 requests per minute.

Path parameters

The following table lists and describes the path parameters for the /data_objects/types/{type_name}/user_relationship_types endpoint.

Query parameters

The following table lists and describes the query parameters for the /data_objects/types/{type_name}/user_relationship_types endpoint.

Example request

This section includes a sample parameter payload and a sample cURL request.

Sample request payload

Use this JSON object as a reference for request parameters.

1
2
3
4
5

{
  "type_name": "account",
  "limit": 100,
  "offset": 0
}

Sample cURL request

This example lists the user relationship kinds you can use to link users to account records.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types/account/user_relationship_types?limit=100&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Response

This section includes a sample successful response and the response fields.

Example success response

The status code 200 could return the following response body.

1
2
3
4
5
6
7
8
9
10

{
  "items": [
    { "rel_kind": "account_user", "display_name": "account_user" }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

display_name currently matches rel_kind.

Response parameters

The following table lists and describes the fields in a successful response.

Errors

The following table lists common errors for this endpoint and how to resolve them.