iOS

iOS Profiles API

The Profiles API from iOS — 8 operation(s) for profiles.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.apple.com/documentation/appstoreconnectapi
📖
APIReference
https://developer.apple.com/documentation/appstoreconnectapi
📖
GettingStarted
https://developer.apple.com/documentation/appstoreconnectapi/creating-api-keys-for-app-store-connect-api
📖
Authentication
https://developer.apple.com/documentation/appstoreconnectapi/generating-tokens-for-api-requests

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ios/refs/heads/main/openapi/ios-profiles-api-openapi.yml

Other Resources

🔗
ReleaseNotes
https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-release-notes
🔗
SDKs
https://github.com/apple/app-store-server-library-swift
🔗
SDKs
https://github.com/apple/app-store-server-library-java
🔗
SDKs
https://github.com/apple/app-store-server-library-python
🔗
SDKs
https://github.com/apple/app-store-server-library-node

OpenAPI Specification

ios-profiles-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: App Store Connect AccessibilityDeclarations Profiles API
  version: 4.3.1
  x-platforms:
    app_store_connect_api: App Store Connect API
  description: The App Store Connect API is the standards-based REST API Apple provides to automate tasks across App Store Connect, Xcode, and Certificates, Identifiers & Profiles. It covers apps, builds, TestFlight, in-app purchases, subscriptions, Game Center, Xcode Cloud, provisioning, pricing and availability, and the full reporting surface (analytics, sales and trends, financial reports, power and performance). This spec is the official OpenAPI 3.0 document published by Apple at https://developer.apple.com/app-store-connect/api/ — mirrored here unmodified except for title-cased operation summaries.
servers:
- url: https://api.appstoreconnect.apple.com/
security:
- itc-bearer-token: []
tags:
- name: Profiles
paths:
  /v1/profiles:
    get:
      tags:
      - Profiles
      operationId: profiles_getCollection
      parameters:
      - name: filter[name]
        in: query
        description: filter by attribute 'name'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: filter[profileType]
        in: query
        description: filter by attribute 'profileType'
        schema:
          type: array
          items:
            type: string
            enum:
            - IOS_APP_DEVELOPMENT
            - IOS_APP_STORE
            - IOS_APP_ADHOC
            - IOS_APP_INHOUSE
            - MAC_APP_DEVELOPMENT
            - MAC_APP_STORE
            - MAC_APP_DIRECT
            - TVOS_APP_DEVELOPMENT
            - TVOS_APP_STORE
            - TVOS_APP_ADHOC
            - TVOS_APP_INHOUSE
            - MAC_CATALYST_APP_DEVELOPMENT
            - MAC_CATALYST_APP_STORE
            - MAC_CATALYST_APP_DIRECT
        style: form
        explode: false
        required: false
      - name: filter[profileState]
        in: query
        description: filter by attribute 'profileState'
        schema:
          type: array
          items:
            type: string
            enum:
            - ACTIVE
            - INVALID
        style: form
        explode: false
        required: false
      - name: filter[id]
        in: query
        description: filter by id(s)
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: sort
        in: query
        description: comma-separated list of sort expressions; resources will be sorted as specified
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - -name
            - profileType
            - -profileType
            - profileState
            - -profileState
            - id
            - -id
        style: form
        explode: false
        required: false
      - name: fields[profiles]
        in: query
        description: the fields to include for returned resources of type profiles
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - platform
            - profileType
            - profileState
            - profileContent
            - uuid
            - createdDate
            - expirationDate
            - bundleId
            - devices
            - certificates
        style: form
        explode: false
        required: false
      - name: fields[bundleIds]
        in: query
        description: the fields to include for returned resources of type bundleIds
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - platform
            - identifier
            - seedId
            - profiles
            - bundleIdCapabilities
            - app
        style: form
        explode: false
        required: false
      - name: fields[devices]
        in: query
        description: the fields to include for returned resources of type devices
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - platform
            - udid
            - deviceClass
            - status
            - model
            - addedDate
        style: form
        explode: false
        required: false
      - name: fields[certificates]
        in: query
        description: the fields to include for returned resources of type certificates
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - certificateType
            - displayName
            - serialNumber
            - platform
            - expirationDate
            - certificateContent
            - activated
            - passTypeId
        style: form
        explode: false
        required: false
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      - name: include
        in: query
        description: comma-separated list of relationships to include
        schema:
          type: array
          items:
            type: string
            enum:
            - bundleId
            - devices
            - certificates
        style: form
        explode: false
        required: false
      - name: limit[certificates]
        in: query
        description: maximum number of related certificates returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      - name: limit[devices]
        in: query
        description: maximum number of related devices returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of Profiles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfilesResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Profiles
    post:
      tags:
      - Profiles
      operationId: profiles_createInstance
      requestBody:
        description: Profile representation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfileCreateRequest'
        required: true
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable request entity error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '201':
          description: Single Profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResponse'
        '409':
          description: Request entity error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Create Profiles
  /v1/profiles/{id}:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - Profiles
      operationId: profiles_getInstance
      parameters:
      - name: fields[profiles]
        in: query
        description: the fields to include for returned resources of type profiles
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - platform
            - profileType
            - profileState
            - profileContent
            - uuid
            - createdDate
            - expirationDate
            - bundleId
            - devices
            - certificates
        style: form
        explode: false
        required: false
      - name: fields[bundleIds]
        in: query
        description: the fields to include for returned resources of type bundleIds
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - platform
            - identifier
            - seedId
            - profiles
            - bundleIdCapabilities
            - app
        style: form
        explode: false
        required: false
      - name: fields[devices]
        in: query
        description: the fields to include for returned resources of type devices
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - platform
            - udid
            - deviceClass
            - status
            - model
            - addedDate
        style: form
        explode: false
        required: false
      - name: fields[certificates]
        in: query
        description: the fields to include for returned resources of type certificates
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - certificateType
            - displayName
            - serialNumber
            - platform
            - expirationDate
            - certificateContent
            - activated
            - passTypeId
        style: form
        explode: false
        required: false
      - name: include
        in: query
        description: comma-separated list of relationships to include
        schema:
          type: array
          items:
            type: string
            enum:
            - bundleId
            - devices
            - certificates
        style: form
        explode: false
        required: false
      - name: limit[certificates]
        in: query
        description: maximum number of related certificates returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      - name: limit[devices]
        in: query
        description: maximum number of related devices returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: Single Profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Get Profiles
    delete:
      tags:
      - Profiles
      operationId: profiles_deleteInstance
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '204':
          description: Success (no content)
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Delete Profiles
  /v1/profiles/{id}/relationships/bundleId:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - Profiles
      operationId: profiles_bundleId_getToOneRelationship
      parameters: []
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: Related linkage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileBundleIdLinkageResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Get Related Profiles / Bundle ID
  /v1/profiles/{id}/bundleId:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - Profiles
      operationId: profiles_bundleId_getToOneRelated
      parameters:
      - name: fields[bundleIds]
        in: query
        description: the fields to include for returned resources of type bundleIds
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - platform
            - identifier
            - seedId
            - profiles
            - bundleIdCapabilities
            - app
        style: form
        explode: false
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: Single BundleId with get
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BundleIdWithoutIncludesResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Get Related Profiles / Bundle ID
  /v1/profiles/{id}/relationships/certificates:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - Profiles
      operationId: profiles_certificates_getToManyRelationship
      parameters:
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of related linkages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileCertificatesLinkagesResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Related Profiles / Certificates
  /v1/profiles/{id}/certificates:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - Profiles
      operationId: profiles_certificates_getToManyRelated
      parameters:
      - name: fields[certificates]
        in: query
        description: the fields to include for returned resources of type certificates
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - certificateType
            - displayName
            - serialNumber
            - platform
            - expirationDate
            - certificateContent
            - activated
            - passTypeId
        style: form
        explode: false
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of Certificates with get
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificatesWithoutIncludesResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Related Profiles / Certificates
  /v1/profiles/{id}/relationships/devices:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - Profiles
      operationId: profiles_devices_getToManyRelationship
      parameters:
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of related linkages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileDevicesLinkagesResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Related Profiles / Devices
  /v1/profiles/{id}/devices:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - Profiles
      operationId: profiles_devices_getToManyRelated
      parameters:
      - name: fields[devices]
        in: query
        description: the fields to include for returned resources of type devices
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - platform
            - udid
            - deviceClass
            - status
            - model
            - addedDate
        style: form
        explode: false
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of Devices with get
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevicesWithoutIncludesResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Related Profiles / Devices
components:
  schemas:
    ProfilesResponse:
      type: object
      title: ProfilesResponse
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Profile'
        included:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/BundleId'
            - $ref: '#/components/schemas/Certificate'
            - $ref: '#/components/schemas/Device'
            discriminator:
              propertyName: type
              mapping:
                certificates: '#/components/schemas/Certificate'
                devices: '#/components/schemas/Device'
                bundleIds: '#/components/schemas/BundleId'
        links:
          $ref: '#/components/schemas/PagedDocumentLinks'
        meta:
          $ref: '#/components/schemas/PagingInformation'
      required:
      - data
      - links
    PagedDocumentLinks:
      type: object
      properties:
        self:
          type: string
          format: uri-reference
        first:
          type: string
          format: uri-reference
        next:
          type: string
          format: uri-reference
      required:
      - self
    ResourceLinks:
      type: object
      properties:
        self:
          type: string
          format: uri-reference
    Device:
      type: object
      title: Device
      properties:
        type:
          type: string
          enum:
          - devices
        id:
          type: string
        attributes:
          type: object
          properties:
            name:
              type: string
            platform:
              $ref: '#/components/schemas/BundleIdPlatform'
            udid:
              type: string
            deviceClass:
              type: string
              enum:
              - APPLE_VISION_PRO
              - APPLE_WATCH
              - IPAD
              - IPHONE
              - IPOD
              - APPLE_TV
              - MAC
            status:
              type: string
              enum:
              - ENABLED
              - DISABLED
            model:
              type: string
            addedDate:
              type: string
              format: date-time
        links:
          $ref: '#/components/schemas/ResourceLinks'
      required:
      - id
      - type
    ErrorSourceParameter:
      type: object
      title: Parameter
      properties:
        parameter:
          type: string
      required:
      - parameter
    ErrorLinks:
      type: object
      properties:
        about:
          type: string
          format: uri-reference
        associated:
          oneOf:
          - type: string
            format: uri-reference
          - type: object
            properties:
              href:
                type: string
                format: uri-reference
              meta:
                type: object
                properties:
                  source:
                    type: string
    Profile:
      type: object
      title: Profile
      properties:
        type:
          type: string
          enum:
          - profiles
        id:
          type: string
        attributes:
          type: object
          properties:
            name:
              type: string
            platform:
              $ref: '#/components/schemas/BundleIdPlatform'
            profileType:
              type: string
              enum:
              - IOS_APP_DEVELOPMENT
              - IOS_APP_STORE
              - IOS_APP_ADHOC
              - IOS_APP_INHOUSE
              - MAC_APP_DEVELOPMENT
              - MAC_APP_STORE
              - MAC_APP_DIRECT
              - TVOS_APP_DEVELOPMENT
              - TVOS_APP_STORE
              - TVOS_APP_ADHOC
              - TVOS_APP_INHOUSE
              - MAC_CATALYST_APP_DEVELOPMENT
              - MAC_CATALYST_APP_STORE
              - MAC_CATALYST_APP_DIRECT
            profileState:
              type: string
              enum:
              - ACTIVE
              - INVALID
            profileContent:
              type: string
            uuid:
              type: string
            createdDate:
              type: string
              format: date-time
            expirationDate:
              type: string
              format: date-time
        relationships:
          type: object
          properties:
            bundleId:
              type: object
              properties:
                links:
                  $ref: '#/components/schemas/RelationshipLinks'
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - bundleIds
                    id:
                      type: string
                  required:
                  - id
                  - type
            devices:
              type: object
              properties:
                links:
                  $ref: '#/components/schemas/RelationshipLinks'
                meta:
                  $ref: '#/components/schemas/PagingInformation'
                data:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                        - devices
                      id:
                        type: string
                    required:
                    - id
                    - type
            certificates:
              type: object
              properties:
                links:
                  $ref: '#/components/schemas/RelationshipLinks'
                meta:
                  $ref: '#/components/schemas/PagingInformation'
                data:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                        - certificates
                      id:
                        type: string
                    required:
                    - id
                    - type
        links:
          $ref: '#/components/schemas/ResourceLinks'
      required:
      - id
      - type
    DocumentLinks:
      type: object
      properties:
        self:
          type: string
          format: uri-reference
      required:
      - self
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              status:
                type: string
              code:
                type: string
              title:
                type: string
              detail:
                type: string
              source:
                oneOf:
                - $ref: '#/components/schemas/ErrorSourcePointer'
                - $ref: '#/components/schemas/ErrorSourceParameter'
              links:
                $ref: '#/components/schemas/ErrorLinks'
              meta:
                type: object
                additionalProperties: {}
            required:
            - code
            - detail
            - statu

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ios/refs/heads/main/openapi/ios-profiles-api-openapi.yml