Own SiriKit? Customize your docs with AI search, analytics, and more.

Claim your docs

SiriKit

GET

/v1/users

https://api.appstoreconnect.apple.com//v1/users

Access Token Required: API Key

Query Params

filter[roles]array

filter by attribute 'roles'

filter[username]array

filter by attribute 'username'

filter[visibleApps]array

filter by id(s) of related 'visibleApps'

sortarray

comma-separated list of sort expressions; resources will be sorted as specified

fields[users]array

the fields to include for returned resources of type users

limitinteger

maximum resources per page

includearray

comma-separated list of relationships to include

fields[apps]array

the fields to include for returned resources of type apps

limit[visibleApps]integer

maximum number of related visibleApps returned (when they are included)

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.appstoreconnect.apple.com//v1/users' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/v1/users

https://api.appstoreconnect.apple.com//v1/users

Access Token Required: API Key

Query Params

filter[roles]array

filter by attribute 'roles'

filter[username]array

filter by attribute 'username'

filter[visibleApps]array

filter by id(s) of related 'visibleApps'

sortarray

comma-separated list of sort expressions; resources will be sorted as specified

fields[users]array

the fields to include for returned resources of type users

limitinteger

maximum resources per page

includearray

comma-separated list of relationships to include

fields[apps]array

the fields to include for returned resources of type apps

limit[visibleApps]integer

maximum number of related visibleApps returned (when they are included)

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.appstoreconnect.apple.com//v1/users' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/v1/users

https://api.appstoreconnect.apple.com//v1/users

Access Token Required: API Key

Query Params

filter[roles]array

filter by attribute 'roles'

filter[username]array

filter by attribute 'username'

filter[visibleApps]array

filter by id(s) of related 'visibleApps'

sortarray

comma-separated list of sort expressions; resources will be sorted as specified

fields[users]array

the fields to include for returned resources of type users

limitinteger

maximum resources per page

includearray

comma-separated list of relationships to include

fields[apps]array

the fields to include for returned resources of type apps

limit[visibleApps]integer

maximum number of related visibleApps returned (when they are included)

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.appstoreconnect.apple.com//v1/users' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/v1/users

https://api.appstoreconnect.apple.com//v1/users

Access Token Required: API Key

Query Params

filter[roles]array

filter by attribute 'roles'

filter[username]array

filter by attribute 'username'

filter[visibleApps]array

filter by id(s) of related 'visibleApps'

sortarray

comma-separated list of sort expressions; resources will be sorted as specified

fields[users]array

the fields to include for returned resources of type users

limitinteger

maximum resources per page

includearray

comma-separated list of relationships to include

fields[apps]array

the fields to include for returned resources of type apps

limit[visibleApps]integer

maximum number of related visibleApps returned (when they are included)

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.appstoreconnect.apple.com//v1/users' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}