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`, `pending` and `refused`
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 sub_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.

Attention

The response within the sub_sellers array may be different depending on whether the partner is an individual or a legal entity. Below, you can see the response example for an individual and legal entity partner.

Legal Entity Partner

Response Object Example
{
  "total": 1,
  "page": 1,
  "offset": 1,
  "sub_sellers": [
    {
      "status": "active",
      "sub_seller_id": "s_k4m6Rw5rlQszEY7fiuRe",
      "name": "Jedi Company",
      "date_created": "2025-07-07T19:26:42.779Z",
      "date_updated": "2025-07-07T20:26:42.779Z",
      "business_name": "Jedi Company LTDA",
      "social_name": "Jedi Company",
      "email": "contact@jedicompany.com",
      "document": "12345678000190",
      "automatic_anticipation_enabled": true,
      "annual_revenue": 1000000000,
      "website": "https://jedicompany.com",
      "phone_number": {
        "country_code": "55",
        "ddd": "11",
        "number": "999999999"
      },
      "main_address": {
        "country": "BR",
        "zip_code": "01234567",
        "state": "SP",
        "city": "São Paulo",
        "neighborhood": "Centro",
        "street": "Rua Jedi",
        "number": "123",
        "complementary": "Room 45"
      },
      "managing_partner": {
        "name": "Luke Skywalker",
        "document": "12345678900",
        "birthdate": "01/01/1980",
        "phone_number": {
          "country_code": "55",
          "ddd": "11",
          "number": "988888888"
        },
        "address": {
          "country": "BR",
          "zip_code": "01234567",
          "state": "SP",
          "city": "São Paulo",
          "neighborhood": "Centro",
          "street": "Rua Jedi",
          "number": "123",
          "complementary": "Apt 45"
        }
      },
      "bank_account": {
        "bank": "001",
        "agency": "1234",
        "agency_digit": "5",
        "account_number": "123456",
        "account_digit": "7",
        "type": "checking",
        "pix": {
          "type": "email",
          "key": "contact@jedicompany.com"
        }
      }
    },
  ]
}

Individual Partner

Response Object Example
{
  "total": 1,
  "page": 1,
  "offset": 1,
  "sub_sellers": [
    {
      "status": "active",
      "sub_seller_id": "sub_7j8i7hj76uvg4l7bc2wo0umdt",
      "name": "Luke Skywalker",
      "date_created": "2025-12-30T09:44:47.215Z",
      "date_updated": "2025-12-30T09:44:47.215Z",
      "email": "luke@skywalker.com",
      "document": "12345678909",
      "automatic_anticipation_enabled": true,
      "annual_revenue": 120000,
      "phone_number": {
        "country_code": "+55",
        "ddd": "11",
        "number": "987654321"
      },
      "address": {
        "country": "BR",
        "zip_code": "01310100",
        "state": "SP",
        "city": "Sao Paulo",
        "neighborhood": "Centro",
        "street": "Avenida Paulista",
        "number": "1000",
        "complementary": "Apt 45"
      },
      "bank_account": {
        "bank": "341",
        "agency": "1234",
        "agency_digit": "5",
        "account_number": "123456",
        "account_digit": "7",
        "type": "checking",
        "pix": {
          "type": "cpf",
          "key": "12345678909"
        }
      }
    }
  ]
}

Array SubSellers

If the query response is greater than or equal to 1, within the sub_sellers property, this is the array of objects that your application receives as a response. If the filter used does not find any partner, an empty array will be returned. The returned objects may be different depending on whether the partner is an individual or a legal entity.

Legal Entity Partner

Attribute	Type	Description
status	string	Partner status. Possible values: `active`, `inactive` or `pending`.
sub_seller_id	string	Partner ID.
date_created	dateTime	Partner creation date in ISODateTime format.
date_updated	dateTime	Partner update date in ISODateTime format.
business_name	string	Partner Legal Name.
social_name	string	Partner Trade Name.
email	string	Partner email.
document	string	Partner CNPJ.
automatic_anticipation_enabled	boolean	Indicates if the receiver will receive automatic anticipations.
annual_revenue	int32	Estimated annual revenue of the partner.
website	string	Company website.
phone_number	object	Partner Phone object.
main_address	object	Partner Main Address object.
managing_partner	object	Partner Managing Partner object.
bank_account	object	Partner Bank Account object.

Individual Partner

Attribute	Type	Description
status	string	Partner status. Possible values: `active`, `inactive` or `pending`.
sub_seller_id	string	Partner ID.
name	string	Partner name.
date_created	dateTime	Partner creation date in ISODateTime format.
date_updated	dateTime	Partner update date in ISODateTime format.
email	string	Partner email.
document	string	Partner CPF.
automatic_anticipation_enabled	boolean	Indicates if the receiver will receive automatic anticipations.
annual_revenue	int32	Estimated annual revenue of the partner.
phone_number	object	Partner Phone object.
address	object	Partner Address object.
bank_account	object	Partner Bank Account object.

Examples

Last 10 partners
Individual and Legal Entity Partners
Partner not found

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": 150,
  "page": 1,
  "offset": 15,
  "sub_sellers": [
    {
      "status": "active",
      "sub_seller_id": "s_k4m6Rw5rlQszEY7fiuRe",
      "name": "Jedi Company",
      "date_created": "2026-01-15T17:36:12.546Z",
      "date_updated": "2026-01-15T18:36:12.546Z",
      "business_name": "Jedi Company LTDA",
      "social_name": "Jedi Company",
      "email": "contact@jedicompany.com",
      "document": "12345678000190",
      "automatic_anticipation_enabled": true,
      "annual_revenue": 1000000000,
      "website": "https://jedicompany.com",
      "phone_number": {
        "country_code": "55",
        "ddd": "11",
        "number": "999999999"
      },
      "main_address": {
        "country": "BR",
        "zip_code": "01234567",
        "state": "SP",
        "city": "São Paulo",
        "neighborhood": "Centro",
        "street": "Rua Jedi",
        "number": "123",
        "complementary": "Room 45"
      },
      "managing_partner": {
        "name": "Luke Skywalker",
        "document": "12345678900",
        "birthdate": "01/01/1980",
        "phone_number": {
          "country_code": "55",
          "ddd": "11",
          "number": "988888888"
        },
        "address": {
          "country": "BR",
          "zip_code": "01234567",
          "state": "SP",
          "city": "São Paulo",
          "neighborhood": "Centro",
          "street": "Rua Jedi",
          "number": "123",
          "complementary": "Apt 45"
        }
      },
      "bank_account": {
        "bank": "001",
        "agency": "1234",
        "agency_digit": "5",
        "account_number": "123456",
        "account_digit": "7",
        "type": "checking",
        "pix": {
          "type": "email",
          "key": "contact@jedicompany.com"
        }
      }
    },
    {
      "+9n": "..."
    }
  ]
}

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": 150,
  "page": 1,
  "offset": 15,
  "sub_sellers": [
    {
      "status": "active",
      "sub_seller_id": "s_k4m6Rw5rlQszEY7fiuRe",
      "name": "Jedi Company",
      "date_created": "2026-01-15T17:36:12.546Z",
      "date_updated": "2026-01-15T18:36:12.546Z",
      "business_name": "Jedi Company LTDA",
      "social_name": "Jedi Company",
      "email": "contact@jedicompany.com",
      "document": "12345678000190",
      "automatic_anticipation_enabled": true,
      "annual_revenue": 1000000000,
      "website": "https://jedicompany.com",
      "phone_number": {
        "country_code": "55",
        "ddd": "11",
        "number": "999999999"
      },
      "main_address": {
        "country": "BR",
        "zip_code": "01234567",
        "state": "SP",
        "city": "São Paulo",
        "neighborhood": "Centro",
        "street": "Rua Jedi",
        "number": "123",
        "complementary": "Room 45"
      },
      "managing_partner": {
        "name": "Luke Skywalker",
        "document": "12345678900",
        "birthdate": "01/01/1980",
        "phone_number": {
          "country_code": "55",
          "ddd": "11",
          "number": "988888888"
        },
        "address": {
          "country": "BR",
          "zip_code": "01234567",
          "state": "SP",
          "city": "São Paulo",
          "neighborhood": "Centro",
          "street": "Rua Jedi",
          "number": "123",
          "complementary": "Apt 45"
        }
      },
      "bank_account": {
        "bank": "001",
        "agency": "1234",
        "agency_digit": "5",
        "account_number": "123456",
        "account_digit": "7",
        "type": "checking",
        "pix": {
          "type": "email",
          "key": "contact@jedicompany.com"
        }
      }
    },
    {
      "status": "active",
      "sub_seller_id": "sub_7j8i7hj76uvg4l7bc2wo0umdt",
      "name": "Luke Skywalker",
      "date_created": "2025-12-30T09:44:47.215Z",
      "date_updated": "2025-12-30T09:44:47.215Z",
      "email": "luke@skywalker.com",
      "document": "12345678909",
      "automatic_anticipation_enabled": true,
      "annual_revenue": 120000,
      "phone_number": {
        "country_code": "+55",
        "ddd": "11",
        "number": "987654321"
      },
      "address": {
        "country": "BR",
        "zip_code": "01310100",
        "state": "SP",
        "city": "Sao Paulo",
        "neighborhood": "Centro",
        "street": "Avenida Paulista",
        "number": "1000",
        "complementary": "Apt 45"
      },
      "bank_account": {
        "bank": "341",
        "agency": "1234",
        "agency_digit": "5",
        "account_number": "123456",
        "account_digit": "7",
        "type": "checking",
        "pix": {
          "type": "cpf",
          "key": "12345678909"
        }
      }
    },
    {
      "+9n": "..."
    }
  ]
}

Request

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

Response404

{
  "errors": {
    "type": "Sub Seller with id [ sub_123456789 ] was not found."
  }
}

Request Query Params​

Response Object​

Legal Entity Partner​

Individual Partner​

Array SubSellers​

Legal Entity Partner​

Individual Partner​

Examples​

Request Query Params

Response Object

Legal Entity Partner

Individual Partner

Array SubSellers

Legal Entity Partner

Individual Partner

Examples