Skip to main content
POST
/
companies
/
{company_id}
/
objects
/
find
Find Objects
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/objects/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "sort_key": "createdAtDesc",
  "query": {
    "customer_id": "<unknown>",
    "customer_identifier": "<unknown>",
    "item_id": "<unknown>",
    "matching_rule_string": "<unknown>"
  }
}
'
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "customer_identifier": "<string>",
      "id": "<string>",
      "item_id": "<string>",
      "object_identifier": "<string>",
      "properties": {},
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
​
pagination
object
required

The pagination parameters for the request

​
sort_key
enum<string>
default:createdAtDesc
required
Available options:
createdAtDesc,
createdAtAsc,
updatedAtAsc,
updatedAtDesc,
aToZ,
zToA
​
query
object

The find criteria for the billable objects

Response

200 - application/json

OK

​
pagination
object
​
results
object[] | null