Get Partners

This route will be used to search for partners, this endpoint returns an array containing partner objects, sorted from the most recently created partner.

If no filter is passed, a array of objects containing your last 10 registered partners will be returned.

GETv3/sub_sellers

Request Query Params

Attribute	Type	Description
sub_seller_id	string	Filter by a specific partner ID.
status	string	Filter by status. Accepted values: active, inactive and pending
date_created	dateTime	Filter by creation date.
date_updated	dateTime	Filter by update date.
count	int32	Returns n partner objects. Maximum of 1,000 and default of 10.
page	int32	Useful for implementing result pagination.

Tip

The properties date_created and date_updated can be used to filter date range searches using the following attributes:

Attribute	Description
<	less than
>	greater than
<=	less than or equal to
>=	greater than or equal to

Request

curl -X GET -G "https://api.marlim.co/v3/sub_sellers" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created=">=1620086400000" \ 
-d date_created="<=1620172799000"

Attention

Date filtering uses unixTimeStamp in milliseconds to represent it. To generate the unixTimeStamp of a date, you can use Google Chrome console with the following JavaScript code: new Date("2023-01-01T00:00:00.000Z").getTime() which will return 1672531200000.

Response Object

When searching for partners, an object with 4 properties is returned: total, page, offset and sellers.

Attribute	Type	Description
total	int32	Total number of partners that meet the filter passed in the query.
page	int32	Current page related to the offset of pages.
offset	int32	Total number of pages for count divided by total of partners returned in the query.
sub_sellers	array	Array of objects containing the partners.
sub_sellers[][sub_seller_id]	string	Partner ID.
sub_sellers[][name]	string	Partner name.
sub_sellers[][status]	string	Partner status.
sub_sellers[][date_created]	dateTime	Partner creation date in ISODateTime format.
sub_sellers[][date_updated]	dateTime	Partner update date in ISODateTime format.
sub_sellers[][business_name]	string	Partner Legal Name.
sub_sellers[][social_name]	string	Partner Trade Name.
sub_sellers[][email]	string	Partner email.
sub_sellers[][document]	string	Partner CNPJ.

Response Example

{
  "total": 1,
  "page": 1,
  "offset": 1,
  "sub_sellers": [
    {
      "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
      "name": "Empresa Jedi",
      "status": "pending",
      "date_created": "2025-07-07T19:26:42.779Z",
      "date_updated": "2025-07-07T20:26:42.779Z",
      "business_name": "Empresa Jedi LTDA",
      "social_name": "Empresa Jedi",
      "email": "contato@empresajedi.com.br",
      "document": "12345678000190"
    }
  ]
}

Examples

All Partners

Request

curl -X GET -G "https://api.marlim.co/v3/sub_sellers" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \

Response200

{
  "total": 1,
  "page": 1,
  "offset": 1,
  "sub_sellers": [
    {
      "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
      "name": "Empresa Jedi",
      "status": "pending",
      "date_created": "2025-07-29T11:38:57.730Z",
      "date_updated": "2025-07-29T11:38:57.730Z",
      "business_name": "Empresa Jedi LTDA",
      "social_name": "Empresa Jedi",
      "email": "contato@empresajedi.com.br",
      "document": "12345678000190"
    }
  ]
}

Filter by Status

Request

curl -X GET -G "https://api.marlim.co/v3/sub_sellers?status=pending" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d status="pending"

Response200

{
  "total": 1,
  "page": 1,
  "offset": 1,
  "sub_sellers": [
    {
      "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
      "name": "Empresa Jedi",
      "status": "pending",
      "date_created": "2025-07-29T11:38:57.730Z",
      "date_updated": "2025-07-29T11:38:57.730Z",
      "business_name": "Empresa Jedi LTDA",
      "social_name": "Empresa Jedi",
      "email": "contato@empresajedi.com.br",
      "document": "12345678000190"
    }
  ]
}