List States

Lists states or regions filtered by the requested country codes.

GET

Authentication

Requirement: Required
Credential type: Bearer API key
Scopes: Not specified

Permissions

Requests are scoped to the target project_id. API-key requests must use a key with an active connection to that project.

Headers

Name	Required	Type	Details
`Authorization`	Yes	Not specified	Description: Bearer credential used to authenticate the request.

Path Parameters

Name	Required	Type	Details
`project_id`	Yes	Not specified	Description: Target project identifier.

Query Parameters

Name	Required	Type	Details
`countries`	No	string	Description: Text value.
`page`	No	integer	Description: Page number for paginated results.
`per_page`	No	integer	Description: Maximum number of records to return.
`q`	No	string	Description: Search text used by this operation.

Request Body

This operation does not accept a request body.

Response Body

Example 200 response

json

{
  "data": [],
  "page": 1
}

Errors

500 internal_server_error

Availability

Available in: v0.1.0
Available since: v0.1.0
Implementation: Available
Deprecation: Not specified
Rate limits: Not specified

Example request

GET/api/projects/{project_id}/sales/locations/states

Base URLhttps://api.modusell.com

curl --request GET \
  --url "https://api.modusell.com/api/projects/example_project_id/sales/locations/states?countries=VALUE&page=VALUE&per_page=VALUE&q=VALUE" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

Examples are not available for this release.

Authentication

Required: Bearer API key.