> ## Documentation Index
> Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get audience profile

> Gets one customer-supplied profile by its E.164 phone. Deleted profiles return 404.

Requires a team API key with `campaigns:read`. Project tokens are not accepted.



## OpenAPI

````yaml api-reference/features/campaigns.json GET /platform/audience-profiles/{phone}
openapi: 3.0.3
info:
  title: Campaigns API methods
  version: 1.0.0
  description: Task-focused campaigns methods across supported Polymorfa connection types.
servers: []
security: []
paths:
  /platform/audience-profiles/{phone}:
    get:
      tags:
        - Audience Profiles
      summary: Get audience profile
      description: >-
        Gets one customer-supplied profile by its E.164 phone. Deleted profiles
        return 404.


        Requires a team API key with `campaigns:read`. Project tokens are not
        accepted.
      operationId: managementGetAudienceProfile
      parameters:
        - name: phone
          in: path
          required: true
          schema:
            type: string
          description: Phone number in international format.
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Stable request correlation identifier.
            X-Trace-Id:
              schema:
                type: string
                pattern: ^[0-9a-f]{32}$
              description: >-
                W3C trace ID of this request. Your `traceparent` trace ID when
                you sent a valid one.
            Polymorfa-Version:
              schema:
                type: string
              description: API version applied to this response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: |-
                          Identifier for this resource.

                          <!-- polymorfa-input-table -->
                          **Value constraints**
                          | Constraint | Accepted input |
                          | --- | --- |
                          | Format | `uuid` |
                      phone:
                        type: string
                        pattern: ^\+[1-9][0-9]{6,14}$
                        description: |-
                          Phone number in international format.

                          <!-- polymorfa-input-table -->
                          **Value constraints**
                          | Constraint | Accepted input |
                          | --- | --- |
                          | Pattern | `^\+[1-9][0-9]{6,14}$` |
                      revision:
                        type: integer
                        minimum: 1
                        description: |-
                          Specifies revision for this data.

                          <!-- polymorfa-input-table -->
                          **Value constraints**
                          | Constraint | Accepted input |
                          | --- | --- |
                          | Numeric value | `1` or greater |
                      tags:
                        type: array
                        maxItems: 20
                        items:
                          type: string
                          maxLength: 48
                        description: |-
                          Tags associated with this data.

                          <!-- polymorfa-input-table -->
                          **Value constraints**
                          | Constraint | Accepted input |
                          | --- | --- |
                          | Array size | At most `20` items |
                          | Item string length | At most `48` characters |
                      attributes:
                        type: object
                        maxProperties: 20
                        additionalProperties:
                          anyOf:
                            - type: string
                              nullable: true
                            - type: number
                            - type: boolean
                        description: |-
                          Structured attributes values for this data.

                          <!-- polymorfa-input-table -->
                          **Value constraints**
                          | Constraint | Accepted input |
                          | --- | --- |
                          | Object size | At most `20` properties |
                      provenance:
                        type: object
                        nullable: true
                        additionalProperties: false
                        properties:
                          source:
                            type: string
                            enum:
                              - api
                              - csv
                              - form
                            description: |-
                              Specifies source for this provenance.

                              <!-- polymorfa-input-table -->
                              **Allowed values**
                              | Value | Meaning |
                              | --- | --- |
                              | `api` | Api. |
                              | `csv` | Csv. |
                              | `form` | Form. |
                          reference:
                            type: string
                            maxLength: 128
                            description: |-
                              Specifies reference for this provenance.

                              <!-- polymorfa-input-table -->
                              **Value constraints**
                              | Constraint | Accepted input |
                              | --- | --- |
                              | String length | At most `128` characters |
                        required:
                          - source
                          - reference
                        description: >-
                          Structured provenance values for this data.


                          <!-- polymorfa-input-table -->

                          **Accepted alternatives**

                          | Alternative | Accepted input |

                          | --- | --- |

                          | Alternative 1 | Type: `object`; Field `source`:
                          `api` or `csv` or `form`; Required fields: `source`,
                          `reference` |

                          | Alternative 2 | `null` |
                      createdAt:
                        type: integer
                        minimum: 0
                        description: >-
                          Unix timestamp in milliseconds when this resource was
                          created.


                          <!-- polymorfa-input-table -->

                          **Value constraints**

                          | Constraint | Accepted input |

                          | --- | --- |

                          | Numeric value | `0` or greater |
                      updatedAt:
                        type: integer
                        minimum: 0
                        description: >-
                          Unix timestamp in milliseconds when this resource was
                          last updated.


                          <!-- polymorfa-input-table -->

                          **Value constraints**

                          | Constraint | Accepted input |

                          | --- | --- |

                          | Numeric value | `0` or greater |
                    required:
                      - id
                      - phone
                      - revision
                      - tags
                      - attributes
                      - provenance
                      - createdAt
                      - updatedAt
                    description: Structured data carried by this object.
                required:
                  - data
        '400':
          $ref: '#/components/responses/management__BadRequest'
        '401':
          $ref: '#/components/responses/management__Unauthorized'
        '403':
          $ref: '#/components/responses/management__Forbidden'
        '404':
          $ref: '#/components/responses/management__NotFound'
      security:
        - management__ApiKeyAuth: []
      servers:
        - url: https://api.polymorfa.com
components:
  responses:
    management__BadRequest:
      description: A path, query, or request-body value did not pass validation.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        X-Trace-Id:
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
          description: >-
            W3C trace ID of this request. Your `traceparent` trace ID when you
            sent a valid one.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Unauthorized:
      description: Missing/invalid credential for this audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        X-Trace-Id:
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
          description: >-
            W3C trace ID of this request. Your `traceparent` trace ID when you
            sent a valid one.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Forbidden:
      description: Authenticated but lacks the required scope/role/audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        X-Trace-Id:
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
          description: >-
            W3C trace ID of this request. Your `traceparent` trace ID when you
            sent a valid one.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__NotFound:
      description: >-
        The requested resource was not found inside the authenticated team or
        project scope.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        X-Trace-Id:
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
          description: >-
            W3C trace ID of this request. Your `traceparent` trace ID when you
            sent a valid one.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
  schemas:
    management__ErrorEnvelope:
      type: object
      required:
        - error
        - data
        - docs
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - upstream_error
              description: |-
                Type discriminator for this object.

                <!-- polymorfa-input-table -->
                **Allowed values**
                | Value | Meaning |
                | --- | --- |
                | `invalid_request_error` | Invalid request error. |
                | `authentication_error` | Authentication error. |
                | `permission_error` | Permission error. |
                | `conflict_error` | Conflict error. |
                | `rate_limit_error` | Rate limit error. |
                | `api_error` | Api error. |
                | `upstream_error` | Upstream error. |
            code:
              type: string
              description: Stable failure code. Use this value for programmatic handling.
            message:
              type: string
              description: Safe explanation of the failure.
            param:
              type: string
              nullable: true
              description: |-
                Invalid request field, or null when no field applies.

                <!-- polymorfa-input-table -->
                **Accepted alternatives**
                | Alternative | Accepted input |
                | --- | --- |
                | Alternative 1 | Type: `string` |
                | Alternative 2 | `null` |
            request_id:
              type: string
              description: >-
                Matches the X-Request-Id response header. Include it when you
                contact support.
            request_log_url:
              type: string
              format: uri
              description: >-
                Console page that shows this request. Returned only to
                organization and project credentials whose request was logged.


                <!-- polymorfa-input-table -->

                **Value constraints**

                | Constraint | Accepted input |

                | --- | --- |

                | Format | `uri` |
          description: Error details returned when the operation fails.
        data:
          type: string
          nullable: true
          enum:
            - null
          description: |-
            Always null for a failed request.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `null` | Null. |

            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        docs:
          type: string
          format: uri
          description: |-
            Documentation link to this failure code.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
  securitySchemes:
    management__ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Send your team API key or project token as `Authorization: Bearer
        <token>`. The credential must have the required permissions. Project
        tokens can access only their own project.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.