List customers

GET

platform

customers

List customers

curl --request GET \
  --url https://api.polymorfa.com/platform/customers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "phoneMasked": "<string>",
      "externalCustomerId": "<string>",
      "status": "active",
      "isDefault": true,
      "archivedAt": 123,
      "numberCount": 1,
      "connectedNumberCount": 1,
      "activePairingLinkState": "<string>",
      "lastActivityAt": 123,
      "needsAttention": true,
      "createdAt": 123,
      "updatedAt": 123
    }
  ],
  "page": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Polymorfa server credential: a scoped pmfa_ organization key, or a pmfa_pt_ project token on project- and session-bound operations inside its exact authenticated project. Keys may be personal or service-account owned. Both enforce selected action scopes; organization keys can address team resources and every project in the organization. Listener and browser client credentials are rejected.

Query Parameters

projectId

string

required

Identifier of the Polymorfa project that owns this resource.

cursor

string

Specifies cursor for this query parameter.

limit

integer

default:25

Specifies limit for this query parameter.

Value constraints

Constraint	Accepted input
Numeric value	`1` through `100` (inclusive)

Required range: 1 <= x <= 100

string

Specifies search for this query parameter.

status

enum<string>

Current status of this resource or operation.

Allowed values

Value	Meaning
`active`	Active.
`archiving`	Archiving.
`archived`	Archived.
`all`	All.

Available options:

active,

archiving,

archived,

all

isDefault

boolean

Whether default.

hasNumbers

boolean

Whether numbers.

needsAttention

boolean

Whether needs attention.

Response

Success

data

object[]

required

Structured data carried by this object.

Show child attributes

page

object

required

Specifies page for this schema.

Show child attributes

⌘I

List customers

curl --request GET \
  --url https://api.polymorfa.com/platform/customers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "phoneMasked": "<string>",
      "externalCustomerId": "<string>",
      "status": "active",
      "isDefault": true,
      "archivedAt": 123,
      "numberCount": 1,
      "connectedNumberCount": 1,
      "activePairingLinkState": "<string>",
      "lastActivityAt": 123,
      "needsAttention": true,
      "createdAt": 123,
      "updatedAt": 123
    }
  ],
  "page": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Authorizations

Query Parameters

Response