Provisioning
Endpoints for managing certificates, devices, profiles, and bundle IDs.
Endpoints
GET /v1/bundleIds
Summary: No summary provided.
Parameters:
filter[name] (query, optional): filter by attribute 'name'filter[platform] (query, optional): filter by attribute 'platform'filter[identifier] (query, optional): filter by attribute 'identifier'filter[seedId] (query, optional): filter by attribute 'seedId'filter[id] (query, optional): filter by id(s)sort (query, optional): comma-separated list of sort expressions; resources will be sorted as specifiedfields[bundleIds] (query, optional): the fields to include for returned resources of type bundleIdsfields[profiles] (query, optional): the fields to include for returned resources of type profilesfields[bundleIdCapabilities] (query, optional): the fields to include for returned resources of type bundleIdCapabilitiesfields[apps] (query, optional): the fields to include for returned resources of type appslimit (query, optional): maximum resources per pageinclude (query, optional): comma-separated list of relationships to includelimit[bundleIdCapabilities] (query, optional): maximum number of related bundleIdCapabilities returned (when they are included)limit[profiles] (query, optional): maximum number of related profiles returned (when they are included)
POST /v1/bundleIds
Summary: No summary provided.
GET /v1/bundleIds/{id}
Summary: No summary provided.
Parameters:
fields[bundleIds] (query, optional): the fields to include for returned resources of type bundleIdsfields[profiles] (query, optional): the fields to include for returned resources of type profilesfields[bundleIdCapabilities] (query, optional): the fields to include for returned resources of type bundleIdCapabilitiesfields[apps] (query, optional): the fields to include for returned resources of type appsinclude (query, optional): comma-separated list of relationships to includelimit[bundleIdCapabilities] (query, optional): maximum number of related bundleIdCapabilities returned (when they are included)limit[profiles] (query, optional): maximum number of related profiles returned (when they are included)
PATCH /v1/bundleIds/{id}
Summary: No summary provided.
DELETE /v1/bundleIds/{id}
Summary: No summary provided.
GET /v1/certificates
Summary: No summary provided.
Parameters:
filter[displayName] (query, optional): filter by attribute 'displayName'filter[certificateType] (query, optional): filter by attribute 'certificateType'filter[serialNumber] (query, optional): filter by attribute 'serialNumber'filter[id] (query, optional): filter by id(s)sort (query, optional): comma-separated list of sort expressions; resources will be sorted as specifiedfields[certificates] (query, optional): the fields to include for returned resources of type certificatesfields[passTypeIds] (query, optional): the fields to include for returned resources of type passTypeIdslimit (query, optional): maximum resources per pageinclude (query, optional): comma-separated list of relationships to include
POST /v1/certificates
Summary: No summary provided.
GET /v1/certificates/{id}
Summary: No summary provided.
Parameters:
fields[certificates] (query, optional): the fields to include for returned resources of type certificatesfields[passTypeIds] (query, optional): the fields to include for returned resources of type passTypeIdsinclude (query, optional): comma-separated list of relationships to include
PATCH /v1/certificates/{id}
Summary: No summary provided.
DELETE /v1/certificates/{id}
Summary: No summary provided.
GET /v1/devices
Summary: No summary provided.
Parameters:
filter[name] (query, optional): filter by attribute 'name'filter[platform] (query, optional): filter by attribute 'platform'filter[udid] (query, optional): filter by attribute 'udid'filter[status] (query, optional): filter by attribute 'status'filter[id] (query, optional): filter by id(s)sort (query, optional): comma-separated list of sort expressions; resources will be sorted as specifiedfields[devices] (query, optional): the fields to include for returned resources of type deviceslimit (query, optional): maximum resources per page
POST /v1/devices
Summary: No summary provided.
GET /v1/devices/{id}
Summary: No summary provided.
Parameters:
fields[devices] (query, optional): the fields to include for returned resources of type devices
PATCH /v1/devices/{id}
Summary: No summary provided.
GET /v1/profiles
Summary: No summary provided.
Parameters:
filter[name] (query, optional): filter by attribute 'name'filter[profileType] (query, optional): filter by attribute 'profileType'filter[profileState] (query, optional): filter by attribute 'profileState'filter[id] (query, optional): filter by id(s)sort (query, optional): comma-separated list of sort expressions; resources will be sorted as specifiedfields[profiles] (query, optional): the fields to include for returned resources of type profilesfields[bundleIds] (query, optional): the fields to include for returned resources of type bundleIdsfields[devices] (query, optional): the fields to include for returned resources of type devicesfields[certificates] (query, optional): the fields to include for returned resources of type certificateslimit (query, optional): maximum resources per pageinclude (query, optional): comma-separated list of relationships to includelimit[certificates] (query, optional): maximum number of related certificates returned (when they are included)limit[devices] (query, optional): maximum number of related devices returned (when they are included)
POST /v1/profiles
Summary: No summary provided.
GET /v1/profiles/{id}
Summary: No summary provided.
Parameters:
fields[profiles] (query, optional): the fields to include for returned resources of type profilesfields[bundleIds] (query, optional): the fields to include for returned resources of type bundleIdsfields[devices] (query, optional): the fields to include for returned resources of type devicesfields[certificates] (query, optional): the fields to include for returned resources of type certificatesinclude (query, optional): comma-separated list of relationships to includelimit[certificates] (query, optional): maximum number of related certificates returned (when they are included)limit[devices] (query, optional): maximum number of related devices returned (when they are included)
DELETE /v1/profiles/{id}
Summary: No summary provided.
GET /v1/bundleIds/{id}/relationships/app
Summary: No summary provided.
GET /v1/bundleIds/{id}/app
Summary: No summary provided.
Parameters:
fields[apps] (query, optional): the fields to include for returned resources of type apps
GET /v1/bundleIds/{id}/relationships/bundleIdCapabilities
Summary: No summary provided.
Parameters:
limit (query, optional): maximum resources per page
GET /v1/bundleIds/{id}/bundleIdCapabilities
Summary: No summary provided.
Parameters:
fields[bundleIdCapabilities] (query, optional): the fields to include for returned resources of type bundleIdCapabilitieslimit (query, optional): maximum resources per page
GET /v1/bundleIds/{id}/relationships/profiles
Summary: No summary provided.
Parameters:
limit (query, optional): maximum resources per page
GET /v1/bundleIds/{id}/profiles
Summary: No summary provided.
Parameters:
fields[profiles] (query, optional): the fields to include for returned resources of type profileslimit (query, optional): maximum resources per page
GET /v1/certificates/{id}/relationships/passTypeId
Summary: No summary provided.
GET /v1/certificates/{id}/passTypeId
Summary: No summary provided.
Parameters:
fields[passTypeIds] (query, optional): the fields to include for returned resources of type passTypeIdsfields[certificates] (query, optional): the fields to include for returned resources of type certificatesinclude (query, optional): comma-separated list of relationships to includelimit[certificates] (query, optional): maximum number of related certificates returned (when they are included)
GET /v1/profiles/{id}/relationships/bundleId
Summary: No summary provided.
GET /v1/profiles/{id}/bundleId
Summary: No summary provided.
Parameters:
fields[bundleIds] (query, optional): the fields to include for returned resources of type bundleIds
GET /v1/profiles/{id}/relationships/certificates
Summary: No summary provided.
Parameters:
limit (query, optional): maximum resources per page
GET /v1/profiles/{id}/certificates
Summary: No summary provided.
Parameters:
fields[certificates] (query, optional): the fields to include for returned resources of type certificateslimit (query, optional): maximum resources per page
GET /v1/profiles/{id}/relationships/devices
Summary: No summary provided.
Parameters:
limit (query, optional): maximum resources per page
GET /v1/profiles/{id}/devices
Summary: No summary provided.
Parameters:
fields[devices] (query, optional): the fields to include for returned resources of type deviceslimit (query, optional): maximum resources per page
Typical Workflows
Use these endpoints to automate provisioning tasks within Apple Store Connect.
Best Practices
- Always authenticate requests using your Apple Store Connect API key (JWT token).
- Handle rate limiting gracefully, as the Apple Store Connect API enforces quotas.
- When writing integrations, refer back to the exact schemas for precise payload construction.
1---2name: provisioning3description: Endpoints for managing certificates, devices, profiles, and bundle IDs.4---56# Provisioning7Endpoints for managing certificates, devices, profiles, and bundle IDs.89## Endpoints1011### `GET /v1/bundleIds`12**Summary**: No summary provided.1314**Parameters**:15- `filter[name]` (query, optional): filter by attribute 'name'16- `filter[platform]` (query, optional): filter by attribute 'platform'17- `filter[identifier]` (query, optional): filter by attribute 'identifier'18- `filter[seedId]` (query, optional): filter by attribute 'seedId'19- `filter[id]` (query, optional): filter by id(s)20- `sort` (query, optional): comma-separated list of sort expressions; resources will be sorted as specified21- `fields[bundleIds]` (query, optional): the fields to include for returned resources of type bundleIds22- `fields[profiles]` (query, optional): the fields to include for returned resources of type profiles23- `fields[bundleIdCapabilities]` (query, optional): the fields to include for returned resources of type bundleIdCapabilities24- `fields[apps]` (query, optional): the fields to include for returned resources of type apps25- `limit` (query, optional): maximum resources per page26- `include` (query, optional): comma-separated list of relationships to include27- `limit[bundleIdCapabilities]` (query, optional): maximum number of related bundleIdCapabilities returned (when they are included)28- `limit[profiles]` (query, optional): maximum number of related profiles returned (when they are included)2930### `POST /v1/bundleIds`31**Summary**: No summary provided.3233### `GET /v1/bundleIds/{id}`34**Summary**: No summary provided.3536**Parameters**:37- `fields[bundleIds]` (query, optional): the fields to include for returned resources of type bundleIds38- `fields[profiles]` (query, optional): the fields to include for returned resources of type profiles39- `fields[bundleIdCapabilities]` (query, optional): the fields to include for returned resources of type bundleIdCapabilities40- `fields[apps]` (query, optional): the fields to include for returned resources of type apps41- `include` (query, optional): comma-separated list of relationships to include42- `limit[bundleIdCapabilities]` (query, optional): maximum number of related bundleIdCapabilities returned (when they are included)43- `limit[profiles]` (query, optional): maximum number of related profiles returned (when they are included)4445### `PATCH /v1/bundleIds/{id}`46**Summary**: No summary provided.4748### `DELETE /v1/bundleIds/{id}`49**Summary**: No summary provided.5051### `GET /v1/certificates`52**Summary**: No summary provided.5354**Parameters**:55- `filter[displayName]` (query, optional): filter by attribute 'displayName'56- `filter[certificateType]` (query, optional): filter by attribute 'certificateType'57- `filter[serialNumber]` (query, optional): filter by attribute 'serialNumber'58- `filter[id]` (query, optional): filter by id(s)59- `sort` (query, optional): comma-separated list of sort expressions; resources will be sorted as specified60- `fields[certificates]` (query, optional): the fields to include for returned resources of type certificates61- `fields[passTypeIds]` (query, optional): the fields to include for returned resources of type passTypeIds62- `limit` (query, optional): maximum resources per page63- `include` (query, optional): comma-separated list of relationships to include6465### `POST /v1/certificates`66**Summary**: No summary provided.6768### `GET /v1/certificates/{id}`69**Summary**: No summary provided.7071**Parameters**:72- `fields[certificates]` (query, optional): the fields to include for returned resources of type certificates73- `fields[passTypeIds]` (query, optional): the fields to include for returned resources of type passTypeIds74- `include` (query, optional): comma-separated list of relationships to include7576### `PATCH /v1/certificates/{id}`77**Summary**: No summary provided.7879### `DELETE /v1/certificates/{id}`80**Summary**: No summary provided.8182### `GET /v1/devices`83**Summary**: No summary provided.8485**Parameters**:86- `filter[name]` (query, optional): filter by attribute 'name'87- `filter[platform]` (query, optional): filter by attribute 'platform'88- `filter[udid]` (query, optional): filter by attribute 'udid'89- `filter[status]` (query, optional): filter by attribute 'status'90- `filter[id]` (query, optional): filter by id(s)91- `sort` (query, optional): comma-separated list of sort expressions; resources will be sorted as specified92- `fields[devices]` (query, optional): the fields to include for returned resources of type devices93- `limit` (query, optional): maximum resources per page9495### `POST /v1/devices`96**Summary**: No summary provided.9798### `GET /v1/devices/{id}`99**Summary**: No summary provided.100101**Parameters**:102- `fields[devices]` (query, optional): the fields to include for returned resources of type devices103104### `PATCH /v1/devices/{id}`105**Summary**: No summary provided.106107### `GET /v1/profiles`108**Summary**: No summary provided.109110**Parameters**:111- `filter[name]` (query, optional): filter by attribute 'name'112- `filter[profileType]` (query, optional): filter by attribute 'profileType'113- `filter[profileState]` (query, optional): filter by attribute 'profileState'114- `filter[id]` (query, optional): filter by id(s)115- `sort` (query, optional): comma-separated list of sort expressions; resources will be sorted as specified116- `fields[profiles]` (query, optional): the fields to include for returned resources of type profiles117- `fields[bundleIds]` (query, optional): the fields to include for returned resources of type bundleIds118- `fields[devices]` (query, optional): the fields to include for returned resources of type devices119- `fields[certificates]` (query, optional): the fields to include for returned resources of type certificates120- `limit` (query, optional): maximum resources per page121- `include` (query, optional): comma-separated list of relationships to include122- `limit[certificates]` (query, optional): maximum number of related certificates returned (when they are included)123- `limit[devices]` (query, optional): maximum number of related devices returned (when they are included)124125### `POST /v1/profiles`126**Summary**: No summary provided.127128### `GET /v1/profiles/{id}`129**Summary**: No summary provided.130131**Parameters**:132- `fields[profiles]` (query, optional): the fields to include for returned resources of type profiles133- `fields[bundleIds]` (query, optional): the fields to include for returned resources of type bundleIds134- `fields[devices]` (query, optional): the fields to include for returned resources of type devices135- `fields[certificates]` (query, optional): the fields to include for returned resources of type certificates136- `include` (query, optional): comma-separated list of relationships to include137- `limit[certificates]` (query, optional): maximum number of related certificates returned (when they are included)138- `limit[devices]` (query, optional): maximum number of related devices returned (when they are included)139140### `DELETE /v1/profiles/{id}`141**Summary**: No summary provided.142143### `GET /v1/bundleIds/{id}/relationships/app`144**Summary**: No summary provided.145146### `GET /v1/bundleIds/{id}/app`147**Summary**: No summary provided.148149**Parameters**:150- `fields[apps]` (query, optional): the fields to include for returned resources of type apps151152### `GET /v1/bundleIds/{id}/relationships/bundleIdCapabilities`153**Summary**: No summary provided.154155**Parameters**:156- `limit` (query, optional): maximum resources per page157158### `GET /v1/bundleIds/{id}/bundleIdCapabilities`159**Summary**: No summary provided.160161**Parameters**:162- `fields[bundleIdCapabilities]` (query, optional): the fields to include for returned resources of type bundleIdCapabilities163- `limit` (query, optional): maximum resources per page164165### `GET /v1/bundleIds/{id}/relationships/profiles`166**Summary**: No summary provided.167168**Parameters**:169- `limit` (query, optional): maximum resources per page170171### `GET /v1/bundleIds/{id}/profiles`172**Summary**: No summary provided.173174**Parameters**:175- `fields[profiles]` (query, optional): the fields to include for returned resources of type profiles176- `limit` (query, optional): maximum resources per page177178### `GET /v1/certificates/{id}/relationships/passTypeId`179**Summary**: No summary provided.180181### `GET /v1/certificates/{id}/passTypeId`182**Summary**: No summary provided.183184**Parameters**:185- `fields[passTypeIds]` (query, optional): the fields to include for returned resources of type passTypeIds186- `fields[certificates]` (query, optional): the fields to include for returned resources of type certificates187- `include` (query, optional): comma-separated list of relationships to include188- `limit[certificates]` (query, optional): maximum number of related certificates returned (when they are included)189190### `GET /v1/profiles/{id}/relationships/bundleId`191**Summary**: No summary provided.192193### `GET /v1/profiles/{id}/bundleId`194**Summary**: No summary provided.195196**Parameters**:197- `fields[bundleIds]` (query, optional): the fields to include for returned resources of type bundleIds198199### `GET /v1/profiles/{id}/relationships/certificates`200**Summary**: No summary provided.201202**Parameters**:203- `limit` (query, optional): maximum resources per page204205### `GET /v1/profiles/{id}/certificates`206**Summary**: No summary provided.207208**Parameters**:209- `fields[certificates]` (query, optional): the fields to include for returned resources of type certificates210- `limit` (query, optional): maximum resources per page211212### `GET /v1/profiles/{id}/relationships/devices`213**Summary**: No summary provided.214215**Parameters**:216- `limit` (query, optional): maximum resources per page217218### `GET /v1/profiles/{id}/devices`219**Summary**: No summary provided.220221**Parameters**:222- `fields[devices]` (query, optional): the fields to include for returned resources of type devices223- `limit` (query, optional): maximum resources per page224225## Typical Workflows226Use these endpoints to automate provisioning tasks within Apple Store Connect.227228## Best Practices229- Always authenticate requests using your Apple Store Connect API key (JWT token).230- Handle rate limiting gracefully, as the Apple Store Connect API enforces quotas.231- When writing integrations, refer back to the exact schemas for precise payload construction.
Andersonlimahw