사용자 관계 목록 조회

이 엔드포인트를 사용하여 하나의 커스텀 오브젝트에 연결된 사용자 목록을 조회할 수 있습니다.

중요

커스텀 오브젝트는 현재 얼리 액세스 단계입니다. 커스텀 오브젝트 API 키 권한이 설정 > API 키에 표시되려면 워크스페이스가 활성화되어야 합니다.

전제 조건

이 엔드포인트를 사용하려면 custom_objects.user_relationships.read 권한이 있는 API 키가 필요합니다.

사용량 제한

이 엔드포인트는 커스텀 오브젝트 읽기 버킷에 포함되며, 기본 제한은 분당 50회 요청입니다.

경로 매개변수

다음 표에서는 /custom_objects/objects/{type_name}/{external_id}/user_relationships 엔드포인트의 경로 매개변수를 나열하고 설명합니다.

쿼리 매개변수

다음 표에서는 /custom_objects/objects/{type_name}/{external_id}/user_relationships 엔드포인트의 쿼리 매개변수를 나열하고 설명합니다.

요청 예시

이 섹션에는 샘플 매개변수 페이로드와 샘플 cURL 요청이 포함되어 있습니다.

샘플 요청 페이로드

이 JSON 오브젝트를 요청 매개변수의 참조로 사용하세요.

1
2
3
4
5
6
7
{
  "type_name": "account",
  "external_id": "acct-123",
  "rel_kind": "account_user",
  "limit": 100,
  "offset": 0
}

샘플 cURL 요청

이 예시에서는 account_user 관계를 통해 acct-123에 연결된 사용자를 목록으로 조회합니다.

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123/user_relationships?rel_kind=account_user&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

응답

이 섹션에는 샘플 성공 응답과 응답 필드가 포함되어 있습니다.

성공 응답 예시

상태 코드 200은 다음과 같은 응답 본문을 반환할 수 있습니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "items": [
    {
      "type_name": "account",
      "external_id": "acct-123",
      "rel_kind": "account_user",
      "user": { "braze_id": "507f1f77bcf86cd799439011" },
      "attributes": { "role": "admin" }
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

user 페이로드에는 braze_id만 포함됩니다.

응답 매개변수

다음 표에서는 성공 응답에 포함된 필드를 나열하고 설명합니다.

오류

다음 표에서는 이 엔드포인트에서 발생할 수 있는 일반적인 오류와 해결 방법을 나열합니다.