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

# Get a phone enrichment result

> Returns the current state of a phone lookup. Start one with [Start a phone enrichment](/api-reference/endpoint/enrich-phone).

`status` is `pending` until the lookup resolves, then `completed` or `not-found`, which are final. `processing` is in the schema but is not currently returned, and a phone lookup never ends `failed`.

`phone_numbers` is filled only on `completed` and is an empty array otherwise. It lists every number Salesfinity holds for the profile, not only the one this request found, including landlines and `P3` numbers kept from earlier lookups. Filter on each number's `validation` before dialing.

Safe to call repeatedly, and a request is never charged twice. Wait a few seconds between polls and stop at a final status. `external_id` is not returned here; it arrives only in the callback.

Returns the current state of a phone lookup started with [Start a phone enrichment](/api-reference/endpoint/enrich-phone).

Polling is the fallback for the `callback_url` webhook. It is safe to call repeatedly, and a request is **never charged twice** however often you poll. Wait a few seconds between polls and stop at a final status.

### Path parameters

| Parameter | Type | Description |
| - | - | - |
| `id` | string | The `_id` returned when the request was created. |

### Status lifecycle

| Status | Meaning |
| - | - |
| `pending` | Accepted; the lookup has not resolved yet. |
| `completed` | Final. A dialable number was found; see `phone_numbers`. 1 credit charged. |
| `not-found` | Final. No source returned a number that is valid, not a landline and not `P3`. No credit charged. |

`processing` appears in the schema but is not currently returned, and a phone lookup never ends `failed`.

<Note>
  `phone_numbers` is returned **only** on a `completed` request. Until then it is an empty array, even if Salesfinity already holds numbers for the profile from an earlier lookup.
</Note>

### Response (200): completed

```json theme={"system"}
{
  "_id": "6703f3a0a9e4b8d1c2f3a4e3",
  "linkedin": "https://www.linkedin.com/in/janedoe",
  "linkedin_username": "janedoe",
  "status": "completed",
  "enrichment_type": "contact",
  "phone_numbers": [
    {
      "_id": "6703f3f6a9e4b8d1c2f3a4f1",
      "number": "+14155550123",
      "country_code": "US",
      "type": "mobile",
      "validation": {
        "phone_number": "+14155550123",
        "is_valid": true,
        "carrier": "AT&T",
        "line_type": "mobile",
        "likely_to_answer": "P1",
        "score": 92,
        "status": "completed",
        "createdAt": "2026-10-03T14:16:30.112Z",
        "updatedAt": "2026-10-03T14:16:30.112Z"
      }
    }
  ],
  "createdAt": "2026-10-03T14:15:04.221Z",
  "updatedAt": "2026-10-03T14:16:38.904Z"
}
```

`phone_numbers` is everything Salesfinity holds for that LinkedIn profile, not only what this request found. A profile enriched twice returns the accumulated list both times.

### Phone number object

| Field | Type | Description |
| - | - | - |
| `_id` | string | ID of the stored number. |
| `number` | string | The number in E.164 format. |
| `country_code` | string \| null | ISO 3166-1 alpha-2 country of the number (`US`, `GB`), not a dialing prefix. `null` when the number could not be parsed. |
| `type` | string | `mobile`, `direct` (a fixed line) or `office`, inferred from the number. |
| `extension` | string | Dial extension. Absent when there is none. |
| `validation` | object | Result of phone validation; see below. |

Salesfinity does not return which source supplied a number.

### Validation object

| Field | Type | Description |
| - | - | - |
| `phone_number` | string | The number that was validated. |
| `is_valid` | boolean | Whether the number passed validation. Numbers that fail are never stored. |
| `carrier` | string | Carrier reported by the validator. |
| `line_type` | string | Line classification, such as `mobile` or `landline`. |
| `likely_to_answer` | string | Answer-likelihood tier, `P1` (most likely) to `P3`. Absent when the number could not be graded. |
| `score` | number \| null | Activity score the tier is derived from. `null` or absent when unavailable. |
| `status` | string | `completed` once validation finished; `pending` while it is still running. |
| `updatedAt` | string | When the number was last validated. A result is reused for up to six months. |

A request only completes on a number that is valid, is not a `landline` and is not tier `P3`; anything else sends the lookup on to the next source. Landlines and `P3` numbers found along the way are kept on the profile and appear in the array, so filter on `validation` rather than assuming every entry is dial-worthy.

### Response (200): still running

```json theme={"system"}
{
  "_id": "6703f3a0a9e4b8d1c2f3a4e3",
  "linkedin": "https://www.linkedin.com/in/janedoe",
  "linkedin_username": "janedoe",
  "status": "pending",
  "enrichment_type": "contact",
  "phone_numbers": [],
  "createdAt": "2026-10-03T14:15:04.221Z",
  "updatedAt": "2026-10-03T14:15:04.221Z"
}
```

### Errors

| Status | When |
| - | - |
| 400 | `id` is not a valid ID |
| 404 | No phone enrichment request has this `id` |
| 502 | Salesfinity could not reach its enrichment service. Retry after a short wait. |


## OpenAPI

````yaml GET /v1/api/enrichment/phone/{id}
openapi: 3.0.1
info:
  title: Salesfinity API
  description: >-
    The Salesfinity API is a JSON-over-HTTPS REST API for the Salesfinity
    parallel dialer.

    Use it to manage contact lists and notes, run the Sequencer, read call logs
    and AI call

    scores, pull team and SDR analytics, and enrich phone numbers and email
    addresses. Webhook

    subscriptions are managed in the Salesfinity dashboard rather than through
    this API.


    ## Base URL


    All requests go to `https://client-api.salesfinity.co`. There is no separate
    sandbox host;

    see the developer portal for the recommended way to test safely.


    ## Authentication


    Every operation requires an API key sent in the `x-api-key` request header.
    Generate a key

    in the Salesfinity dashboard under **Settings → Connections → API &
    Webhooks**. A key is scoped to a

    single team, and every response is filtered to that team.


    ```bash

    curl https://client-api.salesfinity.co/v1/team \
      --header 'x-api-key: YOUR_API_KEY'
    ```


    ## Errors


    Every error the API returns is JSON with the same four fields, so a client
    can parse a

    failure the same way on every endpoint:


    ```json

    {
      "message": "Forbidden resource",
      "error": "Forbidden",
      "statusCode": 403,
      "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
    }

    ```


    `statusCode` matches the HTTP status. `error` is the stable reason phrase to
    branch on.

    `message` is human readable, and is an array of strings when request
    validation fails.

    `request_id` identifies the request in Salesfinity's logs; include it when
    you contact

    support. Note that a missing or invalid API key returns **403**, not 401.


    ## Request IDs


    Every response carries an `X-Request-Id` header, and an error body repeats
    it as

    `request_id`. To trace a request end to end, send your own `X-Request-Id`: 1
    to 128

    characters of letters, digits, `.`, `_`, `:` and `-`. Otherwise Salesfinity
    generates one.


    ## Request bodies


    Bodies are JSON. A field the operation does not define is rejected with
    **400**

    (`property <name> should not exist`). A body may be up to 10 MB on
    `/v1/contact-lists` and

    `/v2/sequencer`, and up to 1 MB everywhere else; a larger one gets **413**.


    Writes that record a person take a `user_id`: the team member the call acts
    as. On

    contact lists and notes, a `user_id` that is not on the team gets **400**.
    On the Sequencer

    it must be an active member, or the call gets **403**.


    ## Pagination


    List endpoints accept `page` (1-based) and `limit` query parameters.
    Defaults, maximums and

    the response envelope differ by endpoint family, so read the `limit`
    parameter and the

    response schema on the operation itself. Scored calls and every paged
    `/v2/sequencer`

    list return `{ data, pagination: { total, page, limit, pages } }`. Call logs
    return that shape

    when a `filters[...]` parameter is sent, and `{ data, pagination: { total,
    page, next } }`

    otherwise.


    ## Rate limits


    Limits are per team: every API key on a team shares them. Requests are
    counted per bucket in

    fixed one-minute windows that start on the minute.


    | Bucket | Routes | Requests per minute |

    |---|---|---|

    | Sequencer reads | `GET /v2/sequencer/*` | 600 |

    | Sequencer writes | `POST`, `PATCH`, `PUT` and `DELETE` on
    `/v2/sequencer/*` | 300 |

    | Heavy reads | `GET /v1/call-log` and `GET /v1/scored-calls` (the lists),
    `/v1/analytics/*`, `/v1/sequences` and `/v1/sequences/{id}` | 120 |

    | Everything else | All other endpoints | 1200 |


    Every response to an authenticated request carries `X-RateLimit-Limit`,

    `X-RateLimit-Remaining` and `X-RateLimit-Reset` (seconds until the window
    resets). Over the

    limit the API returns **429** with a `Retry-After` header giving the seconds
    to wait. These

    are the current limits; Salesfinity gives notice before lowering them.


    ## Idempotency


    `POST` endpoints outside the Sequencer are not idempotent: cap retries, and
    confirm state with

    a `GET` before retrying a create. Every `POST /v2/sequencer/*` endpoint
    except the three

    `/preview` endpoints accepts an `Idempotency-Key` header. Keys are kept for
    24 hours per team.

    A retry with the same key and the same request replays the original
    successful response. The

    same key with a different body or path returns **409**, and so does a retry
    while the first

    request is still running, which is safe to repeat after a moment. A request
    that fails frees

    its key, so a retry after a 5xx runs the write again: confirm state with a
    `GET` before

    retrying a create that failed with a 5xx.
  version: 1.0.0
  termsOfService: https://salesfinity.ai/terms
  contact:
    name: Salesfinity Support
    email: hello@salesfinity.co
    url: https://support.salesfinity.ai
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://client-api.salesfinity.co
    description: Production. The only public Salesfinity API host.
security:
  - ApiKeyAuth: []
tags:
  - name: Contact Lists
    description: >-
      Create, read, merge, and delete CSV contact lists, add or remove the
      contacts inside them, and put a list's contacts in its dialing queue.
  - name: Teams
    description: >-
      Read the team that owns the API key, including its members, licenses, and
      statuses.
  - name: Dispositions
    description: Read the default and custom call outcomes configured for the team.
  - name: Sequences
    description: >-
      Read the external CRM sequences that appear on the team's call logs, with
      call counts and first and last use. Not the Salesfinity Sequencer, which
      is the Sequencer Sequences group.
  - name: Call Logs
    description: >-
      Read the raw call history for the team, with filtering, sorting, and
      pagination.
  - name: Analytics
    description: Aggregated call metrics for the team, by contact list, and by SDR.
  - name: Snoozed Contacts
    description: Read and manage contacts that have been snoozed out of the dialing queue.
  - name: Follow-up Tasks
    description: Read follow-up tasks created from call outcomes.
  - name: Custom Fields
    description: Read the custom field mappings configured for the team.
  - name: Scored Calls
    description: Read AI-scored calls with per-facet scoring and coaching recommendations.
  - name: Notes
    description: >-
      Attach freeform notes to a person or company, list them, and pin the ones
      that matter.
  - name: Enrichment
    description: >-
      Look up phone numbers and work or personal email addresses for a LinkedIn
      profile, and check the team's remaining enrichment credits.
  - name: Sequencer Sequences
    description: >-
      Create, configure, enable and duplicate Sequencer cadences, and read their
      analytics. Distinct from the Sequences group, which lists sequence names
      observed on call logs from an external CRM.
  - name: Sequencer Steps
    description: The ordered steps that make up a cadence.
  - name: Sequencer Templates
    description: Reusable email subjects and bodies that email steps send from.
  - name: Sequencer Enrollments
    description: >-
      Contacts inside a sequence: where they are in the cadence, and the verbs
      that move them. Bulk verbs take up to 500 enrollments.
  - name: Sequencer Enrolment Runs
    description: >-
      Background enrollment of up to 5,000 contacts at a time, and the preview
      that shows what a batch would do.
  - name: Sequencer Tasks
    description: The rep task queue a cadence produces, plus standalone one-off tasks.
  - name: Sequencer Suppression
    description: >-
      The team do-not-contact list, checked when someone is enrolled and again
      before every email is sent.
  - name: Sequencer Policies
    description: 'Rules of engagement: what may be enrolled, and what happens at each step.'
  - name: Sequencer Settings
    description: Team-level sequencer settings and sending mailboxes. Read-only.
externalDocs:
  description: Salesfinity API documentation
  url: https://docs.salesfinity.ai
paths:
  /v1/api/enrichment/phone/{id}:
    get:
      tags:
        - Enrichment
      summary: Get a phone enrichment result
      description: >-
        Returns the current state of a phone lookup. Start one with [Start a
        phone enrichment](/api-reference/endpoint/enrich-phone).


        `status` is `pending` until the lookup resolves, then `completed` or
        `not-found`, which are final. `processing` is in the schema but is not
        currently returned, and a phone lookup never ends `failed`.


        `phone_numbers` is filled only on `completed` and is an empty array
        otherwise. It lists every number Salesfinity holds for the profile, not
        only the one this request found, including landlines and `P3` numbers
        kept from earlier lookups. Filter on each number's `validation` before
        dialing.


        Safe to call repeatedly, and a request is never charged twice. Wait a
        few seconds between polls and stop at a final status. `external_id` is
        not returned here; it arrives only in the callback.
      operationId: get-phone-enrichment
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            example: 6703f3a0a9e4b8d1c2f3a4e3
          description: >-
            The `_id` returned by [Start a phone
            enrichment](/api-reference/endpoint/enrich-phone).
      responses:
        '200':
          description: Current state of the lookup.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneEnrichmentRequestDTO'
              example:
                _id: 6703f3a0a9e4b8d1c2f3a4e3
                linkedin: https://www.linkedin.com/in/janedoe
                linkedin_username: janedoe
                status: completed
                enrichment_type: contact
                createdAt: '2026-10-03T14:15:04.221Z'
                updatedAt: '2026-10-03T14:16:38.904Z'
                phone_numbers:
                  - _id: 6703f3f6a9e4b8d1c2f3a4f1
                    number: '+14155550123'
                    country_code: US
                    type: mobile
                    validation:
                      phone_number: '+14155550123'
                      is_valid: true
                      carrier: AT&T
                      line_type: mobile
                      likely_to_answer: P1
                      score: 92
                      status: completed
                      createdAt: '2026-10-03T14:16:30.112Z'
                      updatedAt: '2026-10-03T14:16:30.112Z'
        '400':
          description: '`id` is not a valid ID.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: 'Invalid ObjectId format for parameter: id'
                error: Bad Request
                statusCode: 400
                request_id: 0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: No phone enrichment request has this `id`.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: Enrichment request not found.
                error: Not Found
                statusCode: 404
                request_id: 0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          description: >-
            Salesfinity could not reach its enrichment service; `message`
            describes the network error. Retry after a short wait.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: socket hang up
                error: Bad Gateway
                statusCode: 502
                request_id: 0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10
components:
  headers:
    X-Request-Id:
      description: >-
        Identifies the request in Salesfinity's logs, and matches `request_id`
        in an error body. Echoes the `X-Request-Id` you sent when it is 1 to 128
        characters of letters, digits, `.`, `_`, `:` and `-`; otherwise
        Salesfinity generates one.
      schema:
        type: string
      example: 0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10
    X-RateLimit-Limit:
      description: >-
        Requests allowed per minute in the rate-limit bucket this request
        counted against. Limits are per team: every API key on the team shares
        them.
      schema:
        type: integer
      example: 300
    X-RateLimit-Remaining:
      description: Requests left in the current one-minute window for this bucket.
      schema:
        type: integer
        minimum: 0
      example: 0
    X-RateLimit-Reset:
      description: >-
        Seconds until the current window ends and the bucket resets. At least 1
        and at most 60.
      schema:
        type: integer
        minimum: 0
      example: 12
    Retry-After:
      description: >-
        Seconds to wait before retrying: the time left in the current one-minute
        window. At least 1 and at most 60.
      schema:
        type: integer
        minimum: 0
      example: 12
  schemas:
    PhoneEnrichmentRequestDTO:
      type: object
      properties:
        _id:
          type: string
          description: >-
            Enrichment request ID. Use this to poll GET
            /v1/api/enrichment/phone/{id}, and to match the request_id in the
            callback.
          example: 507f1f77bcf86cd799439011
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - not-found
          description: >-
            `pending` until the lookup resolves, then `completed` (a dialable
            number was found) or `not-found`. `processing` is not currently
            returned, and a phone lookup never resolves to `failed`.
        linkedin:
          type: string
          description: The LinkedIn profile URL as you sent it.
          example: https://www.linkedin.com/in/username
        linkedin_username:
          type: string
          description: The username extracted from the LinkedIn URL.
          example: username
        enrichment_type:
          type: string
          enum:
            - contact
          description: Always `contact` for phone enrichment.
        phone_numbers:
          type: array
          description: >-
            Every number Salesfinity holds for the profile, not only the one
            this request found, including landlines and `P3` numbers kept from
            earlier lookups. Populated only when `status` is `completed`; an
            empty array otherwise. Absent from the response to Start a phone
            enrichment.
          items:
            $ref: '#/components/schemas/PhoneNumberDTO'
        createdAt:
          type: string
          format: date-time
          example: '2026-08-27T10:15:04.221Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-08-27T10:16:38.904Z'
    Error:
      type: object
      title: Error
      description: >-
        The error envelope returned by every Salesfinity API error response. The
        shape is identical across all status codes and all endpoints, and
        `request_id` is present on every error the API returns.
      required:
        - message
        - error
        - statusCode
        - request_id
      properties:
        message:
          description: >-
            Human-readable description of the failure. A string for most errors,
            and an array of strings when request validation fails, with one
            entry per field that did not validate.
          oneOf:
            - type: string
            - type: array
              items:
                type: string
          example: Forbidden resource
        error:
          type: string
          description: >-
            Stable HTTP reason phrase for the status code, such as `Forbidden`.
            One exception: a 403 from a `/v2/sequencer` write whose `user_id`
            has no active plan or seat carries `NO_ACTIVE_PLAN` here. Branch on
            this rather than on `message`.
          example: Forbidden
        statusCode:
          type: integer
          format: int32
          description: >-
            HTTP status code, repeated in the body so it survives transports
            that drop it.
          example: 403
        request_id:
          type: string
          description: >-
            Identifies the request in Salesfinity's logs; the same value as the
            `X-Request-Id` response header. Include it when you contact support.
          example: 0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10
        errors:
          type: array
          items:
            type: string
          description: >-
            Present on a few Sequencer errors, such as a rules-of-engagement
            policy whose rules fail the catalog check: one entry per problem.
            Other fields an upstream service sends are passed through unchanged
            too.
      example:
        message: Forbidden resource
        error: Forbidden
        statusCode: 403
        request_id: 0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10
    PhoneNumberDTO:
      type: object
      properties:
        number:
          type: string
          description: The number in E.164 format.
          example: '+14155550123'
        country_code:
          type: string
          description: >-
            ISO 3166-1 alpha-2 country of the number (`US`, `GB`), not a dialing
            prefix. `null` when the number could not be parsed.
          example: US
        type:
          type: string
          enum:
            - mobile
            - direct
            - office
          description: >-
            Line category inferred from the number: `mobile`, `direct` (a fixed
            line) or `office` (anything else).
        extension:
          type: string
          description: Dial extension. Absent when there is none.
        source:
          type: string
          description: >-
            Not returned. Salesfinity removes the source of each number from API
            responses.
          deprecated: true
        validation:
          $ref: '#/components/schemas/PhoneValidationDTO'
        _id:
          type: string
          description: ID of the stored number.
          example: 6703f3f6a9e4b8d1c2f3a4f1
    PhoneValidationDTO:
      type: object
      description: >-
        Result of the phone validation pass. A request only completes on a
        number that is valid, is not a landline, and is not tier P3.
      properties:
        phone_number:
          type: string
          example: '+14155550123'
        is_valid:
          type: boolean
          description: >-
            Whether the number passed validation. Numbers that fail are never
            stored.
          example: true
        carrier:
          type: string
          description: Carrier reported by the validator.
          example: AT&T
        line_type:
          type: string
          description: Line classification, e.g. mobile or landline.
          example: mobile
        likely_to_answer:
          type: string
          enum:
            - P1
            - P2
            - P3
          description: >-
            Answer-likelihood tier: `P1` is the most likely to answer, `P3` the
            least. Absent when the validator could not grade the number.
          example: P1
        score:
          type: number
          description: >-
            Activity score the tier is derived from. `null` or absent when
            unavailable.
          example: 92
        status:
          type: string
          enum:
            - pending
            - completed
          description: >-
            `completed` once validation resolved; `pending` while it is still
            running.
        createdAt:
          type: string
          format: date-time
          description: When the number was first validated.
        updatedAt:
          type: string
          format: date-time
          description: >-
            When the number was last validated. A validation result is reused
            for up to six months.
  responses:
    Forbidden:
      description: >-
        Forbidden. The `x-api-key` header is missing, malformed, revoked, or
        belongs to another team. Send a valid key in the `x-api-key` header.
        Salesfinity returns 403 (not 401) for a missing, malformed, revoked, or
        wrong-team key. On an operation that takes a `user_id`, 403 can also
        mean that team member may not do this, for example a Sequencer call
        acting as an inactive member; `message` then says why. A `/v2/sequencer`
        write whose `user_id` has no active plan or seat gets `error` set to
        `NO_ACTIVE_PLAN` instead of `Forbidden`; assign the member a seat.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Forbidden resource
            error: Forbidden
            statusCode: 403
            request_id: 0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10
    TooManyRequests:
      description: >-
        Too Many Requests. The team has used its per-minute budget for this
        rate-limit bucket; the limit is shared by every API key on the team.
        Wait the number of seconds in the `Retry-After` header (never more than
        60), then retry. The request was refused before it ran, so retrying it
        is safe even for a write. Pace bulk work with the
        `X-RateLimit-Remaining` and `X-RateLimit-Reset` headers. See
        /api-reference/rate-limits.
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Rate limit of 300 requests per minute exceeded. Retry in 12s.
            error: Too Many Requests
            statusCode: 429
            request_id: 0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10
    InternalServerError:
      description: >-
        Internal Server Error. Something went wrong on the Salesfinity side.
        Retry with exponential backoff. If it persists, contact
        hello@salesfinity.co with the `request_id` from the body, the request
        path and the timestamp. The contact-list, snoozed-contact and note
        routes do not validate an ID in the path, and the analytics routes do
        not validate `user_ids`: an ID that is not a 24-character hexadecimal
        string returns 500 there, and retrying does not help, so check the ID
        first.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Internal server error
            error: Internal Server Error
            statusCode: 500
            request_id: 0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Team-scoped API key generated in the Salesfinity dashboard under
        Settings → Connections → API & Webhooks. A missing or invalid key
        returns HTTP 403.

````

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