# List accounts by phone number

List accounts by phone number.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Core platform - Accounts",
    "version": "1.0.0",
    "description": "API used to manage accounts domain",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "API server for testing"
    }
  ],
  "tags": [
    {
      "name": "Accounts",
      "description": "Endpoints to manage accounts"
    }
  ],
  "components": {
    "parameters": {
      "MaxItemsQuery": {
        "name": "maxItems",
        "in": "query",
        "description": "Number of items on current page. `200` maximum. Default is `200`.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "maximum": 200,
          "example": 100
        }
      },
      "NextCursorQuery": {
        "name": "nextCursor",
        "in": "query",
        "description": "Cursor value used to get the next page. This is the `next_cursor` value returned in the response.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "MEgCQQCo9..."
        }
      }
    },
    "schemas": {
      "AccountEntityResponseV5": {
        "type": "object",
        "description": "Account entity",
        "properties": {
          "entity_id": {
            "$ref": "#/components/schemas/EntityID"
          },
          "entity_external_id": {
            "$ref": "#/components/schemas/AccountExternalId"
          }
        }
      },
      "AccountExternalId": {
        "type": "string",
        "description": "\nClient-created ID from an external system or application. **REQUIRED** for `VIRTUAL` accounts.\n",
        "maxLength": 60,
        "example": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f"
      },
      "AccountID": {
        "type": "integer",
        "format": "int64",
        "description": "Account ID",
        "example": 1001
      },
      "AccountsV5Request": {
        "required": [
          "phone"
        ],
        "properties": {
          "phone": {
            "required": [
              "number"
            ],
            "type": "object",
            "description": "Filter by phone number, area code, and/or country code. Phone number is required.",
            "properties": {
              "number": {
                "$ref": "#/components/schemas/PhoneNumber"
              },
              "area_code": {
                "$ref": "#/components/schemas/AreaCode"
              },
              "country_code": {
                "$ref": "#/components/schemas/PhoneCountryCode"
              }
            }
          }
        }
      },
      "AccountsV5Response": {
        "type": "object",
        "description": "Object response for account",
        "properties": {
          "account_id": {
            "$ref": "#/components/schemas/AccountID"
          },
          "account_external_id": {
            "$ref": "#/components/schemas/AccountExternalId"
          },
          "is_centralizer": {
            "$ref": "#/components/schemas/IsCentralizer"
          },
          "entities": {
            "type": "array",
            "description": "List of account's entities",
            "items": {
              "$ref": "#/components/schemas/AccountEntityResponseV5"
            }
          }
        }
      },
      "AreaCode": {
        "type": "string",
        "description": "Phone number area code",
        "maxLength": 2,
        "example": "51"
      },
      "IsCentralizer": {
        "type": "boolean",
        "description": "Is this a centralizer account? A centralizer account, within the account hierarchy, is the account responsible for invoice billing. Defaults to `false`.",
        "example": false
      },
      "CurrentPageCount": {
        "type": "integer",
        "format": "int32",
        "description": "Number of items on the current page",
        "example": 100
      },
      "CursorResponse": {
        "type": "object",
        "properties": {
          "next_cursor": {
            "$ref": "#/components/schemas/NextCursor"
          },
          "has_next": {
            "$ref": "#/components/schemas/HasNext"
          },
          "count": {
            "$ref": "#/components/schemas/CurrentPageCount"
          }
        }
      },
      "EntityID": {
        "type": "integer",
        "format": "int64",
        "description": "Entity ID",
        "minimum": 1,
        "example": 1234567891
      },
      "ExternalServiceCode": {
        "type": "string",
        "description": "Code returned from the external service"
      },
      "HasNext": {
        "type": "boolean",
        "description": "Are there more results (retrieved using the `next_cursor` value)?",
        "example": true
      },
      "MessageDetailsResponse": {
        "type": "object",
        "description": "Object response for a user message",
        "properties": {
          "payload": {
            "type": "array",
            "description": "Details for the request payload errors",
            "items": {
              "$ref": "#/components/schemas/MessagePayloadResponse"
            }
          },
          "parameters": {
            "type": "array",
            "description": "Details for the query parameter errors",
            "items": {
              "$ref": "#/components/schemas/MessageParameterResponse"
            }
          },
          "external": {
            "type": "array",
            "description": "Details for the external service error",
            "items": {
              "$ref": "#/components/schemas/MessageExternalResponse"
            }
          }
        }
      },
      "MessageExternalResponse": {
        "type": "object",
        "description": "Object response for detailing external errors for a user message",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/ExternalServiceCode"
          },
          "message": {
            "type": "string",
            "description": "Message description from the external service"
          }
        }
      },
      "MessageParameterResponse": {
        "type": "object",
        "description": "Object response for detailing query parameters errors for a user message",
        "properties": {
          "field": {
            "$ref": "#/components/schemas/ValidationErrorField"
          },
          "message": {
            "$ref": "#/components/schemas/ValidationErrorMessage"
          }
        }
      },
      "MessagePayloadResponse": {
        "type": "object",
        "description": "Object response for detailing request payload errors for a user message",
        "properties": {
          "field": {
            "$ref": "#/components/schemas/ValidationErrorField"
          },
          "message": {
            "$ref": "#/components/schemas/ValidationErrorMessage"
          }
        }
      },
      "UserMessageCode": {
        "type": "string",
        "description": "Code that identifies the user message",
        "example": "EACC0000"
      },
      "UserMessage": {
        "type": "string",
        "description": "User message",
        "example": "Timeout while executing the request"
      },
      "MessageResponse": {
        "type": "object",
        "description": "Object response for user message",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/UserMessageCode"
          },
          "message": {
            "$ref": "#/components/schemas/UserMessage"
          },
          "details": {
            "$ref": "#/components/schemas/MessageDetailsResponse"
          }
        }
      },
      "NextCursor": {
        "type": "string",
        "description": "Cursor value for the next page",
        "example": "MEgCQQCo9+BpMRYQ/dL3DS2CyJxRF+j6ctbT3/Qp84+KeFhnii7NT7fELilKUSnxS30WAvQCCo2yU1orfgqr41mM70MBAgMBAAE="
      },
      "PhoneCountryCode": {
        "description": "Phone number's country code",
        "type": "string",
        "maxLength": 5,
        "example": "555"
      },
      "PhoneNumber": {
        "type": "string",
        "description": "Phone number",
        "maxLength": 15,
        "example": "11912345678"
      },
      "ValidationErrorField": {
        "type": "string",
        "description": "Non-valid field"
      },
      "ValidationErrorMessage": {
        "type": "string",
        "description": "Validation error description"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "paths": {
    "/accounts/v5/accounts/search": {
      "post": {
        "operationId": "post-accounts-v5-accounts-search",
        "summary": "List accounts by phone number",
        "description": "List accounts by phone number.",
        "tags": [
          "Accounts"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/NextCursorQuery"
          },
          {
            "$ref": "#/components/parameters/MaxItemsQuery"
          }
        ],
        "requestBody": {
          "description": "Account search fields",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountsV5Request"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "List of accounts returned",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/CursorResponse"
                    }
                  ],
                  "properties": {
                    "items": {
                      "type": "array",
                      "description": "List of result items",
                      "items": {
                        "$ref": "#/components/schemas/AccountsV5Response"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessageResponse"
                },
                "examples": {
                  "Invalid payload": {
                    "value": {
                      "code": "EACC0004",
                      "message": "Failed during validation of request payload",
                      "detail": {
                        "payload": [
                          {
                            "field": "phone",
                            "message": "Field is required"
                          }
                        ]
                      }
                    }
                  },
                  "Invalid next_cursor parameter": {
                    "value": {
                      "code": "WACC0011",
                      "message": "Invalid cursor value"
                    }
                  },
                  "Invalid maxItems parameter": {
                    "value": {
                      "code": "EACC0005",
                      "message": "One or more parameters with invalid format",
                      "detail": {
                        "parameters": [
                          {
                            "field": "maxItems",
                            "message": "Value must be greater than zero"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessageResponse"
                },
                "examples": {
                  "Timeout execution": {
                    "value": {
                      "code": "EACC0000",
                      "message": "Timeout while executing the request"
                    }
                  },
                  "Generic message": {
                    "value": {
                      "code": "EACC9999",
                      "message": "Something went wrong, please try again later"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```