--- title: "Get all counterparts" method: GET path: "/counterparts" tags: ["Counterparts"] --- # Get all counterparts `GET /counterparts` ## Request - Base URL: `https://api.sandbox.monite.com/v1` - URL: `https://api.sandbox.monite.com/v1/counterparts` - Auth: HTTP bearer ## Query parameters - `iban` string - `sort_code` string - `account_number` string - `tax_id` string - `vat_id` string - `id__in` string, uuid - `order` 'asc' | 'desc' - `limit` integer - `pagination_token` string - `sort` 'counterpart_name' - `type` 'individual' | 'organization' - `counterpart_name` string - `counterpart_name__iexact` string - `counterpart_name__contains` string - `counterpart_name__icontains` string - `is_vendor` boolean - `is_customer` boolean - `email` string - `email__contains` string - `email__icontains` string - `created_at__gt` string, date-time - `created_at__lt` string, date-time - `created_at__gte` string, date-time - `created_at__lte` string, date-time - `address.country` string - `address.city` string - `address.postal_code` string - `address.state` string - `address.line1` string - `address.line2` string - `tag_ids__in` string, uuid ## Headers - `x-monite-version` string, required - `x-monite-entity-id` string, required ## Response `200` Successful Response - CounterpartPaginationResponse: A paginated list of counterparts - `data` CounterpartResponse[], required - union: A Counterpart object contains information about an organization (juridical person) or individual (natural person) that provides goods and services to or buys them from an [SME](https://docs.monite.com/docs/glossary#sme). - CounterpartIndividualRootResponse: Represents counterparts that are individuals (natural persons). - `id` string, uuid, required: Unique ID of the counterpart. - `created_at` string, date-time, required: Date and time when the counterpart was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. - `updated_at` string, date-time, required: Date and time when the counterpart was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. - `created_automatically` boolean: `true` if the counterpart was created automatically by Monite when processing incoming invoices with OCR. `false` if the counterpart was created by the API client. - `created_by_entity_user_id` string, uuid: Entity user ID of counterpart creator. - `default_billing_address_id` string, uuid: ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If `default_billing_address_id` is not defined, the default address is instead used as the billing address for ACH payments. - `default_shipping_address_id` string, uuid: ID of the shipping address. - `external_reference` string: A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity. - `individual` CounterpartIndividualResponse, required: Represents counterparts that are individuals (natural persons). - `email` string, email: The person's email address. - `first_name` string, required: The person's first name. - `is_customer` boolean, required: Indicates if the counterpart is a customer. - `is_vendor` boolean, required: Indicates if the counterpart is a vendor. - `last_name` string, required: The person's last name. - `phone` string: The person's phone number. - `tags` CounterpartTagSchema[]: The list of tags for this counterpart. - `id` string, uuid, required: A unique ID of this tag. - `created_at` string, date-time, required: Date and time when the tag was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. - `updated_at` string, date-time, required: Date and time when the tag was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. - `category` 'document_type' | 'department' | 'project' | 'cost_center' | 'vendor_type' | 'payment_method' | 'approval_status' - `created_by_entity_user_id` string, uuid: ID of the user who created the tag. - `description` string: The tag description. - `name` string, required: The tag name. - `title` string: The person's title or honorific. Examples: Mr., Ms., Dr., Prof. - `language` 'ab' | 'aa' | 'af' | 'ak' | 'sq' | 'am' | 'ar' | 'an' | 'hy' | 'av' | 'ae' | 'ay' | 'az' | 'bm' | 'ba' | 'eu' | 'be' | 'bn' | 'bi' | 'bs' | 'br' | 'bg' | 'my' | 'ca' | 'ch' | 'ce' | 'ny' | 'zh' | 'cu' | 'cv' | 'kw' | 'co' | 'cr' | 'hr' | 'cs' | 'da' | 'dv' | 'nl' | 'dz' | 'en' | 'eo' | 'et' | 'ee' | 'fo' | 'fj' | 'fi' | 'fr' | 'fy' | 'ff' | 'gd' | 'gl' | 'lg' | 'ka' | 'de' | 'el' | 'kl' | 'gn' | 'gu' | 'ht' | 'ha' | 'he' | 'hz' | 'hi' | 'ho' | 'hu' | 'io' | 'ig' | 'id' | 'ia' | 'ie' | 'iu' | 'ik' | 'ga' | 'it' | 'ja' | 'jv' | 'kn' | 'kr' | 'ks' | 'kk' | 'km' | 'ki' | 'rw' | 'ky' | 'kv' | 'kg' | 'ko' | 'kj' | 'ku' | 'lo' | 'la' | 'lv' | 'li' | 'ln' | 'lt' | 'lu' | 'lb' | 'mk' | 'mg' | 'ms' | 'ml' | 'mt' | 'gv' | 'mi' | 'mr' | 'mh' | 'mn' | 'na' | 'nv' | 'nd' | 'nr' | 'ng' | 'ne' | 'no' | 'nb' | 'nn' | 'ii' | 'oc' | 'oj' | 'om' | 'os' | 'pi' | 'ps' | 'fa' | 'pl' | 'pt' | 'pa' | 'qu' | 'ro' | 'rm' | 'rn' | 'ru' | 'se' | 'sm' | 'sg' | 'sa' | 'sc' | 'sr' | 'sn' | 'sd' | 'si' | 'sk' | 'sl' | 'so' | 'st' | 'es' | 'su' | 'sw' | 'ss' | 'sv' | 'tl' | 'ty' | 'tg' | 'ta' | 'tt' | 'te' | 'th' | 'bo' | 'ti' | 'to' | 'ts' | 'tn' | 'tr' | 'tk' | 'tw' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'cy' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zu' - `reminders_enabled` boolean - `tax_id` string: The counterpart's taxpayer identification number or tax ID. - `type` 'individual' | 'organization', required - CounterpartOrganizationRootResponse: Represents counterparts that are organizations (juridical persons). - `id` string, uuid, required: Unique ID of the counterpart. - `created_at` string, date-time, required: Date and time when the counterpart was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. - `updated_at` string, date-time, required: Date and time when the counterpart was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. - `created_automatically` boolean: `true` if the counterpart was created automatically by Monite when processing incoming invoices with OCR. `false` if the counterpart was created by the API client. - `created_by_entity_user_id` string, uuid: Entity user ID of counterpart creator. - `default_billing_address_id` string, uuid: ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If `default_billing_address_id` is not defined, the default address is instead used as the billing address for ACH payments. - `default_shipping_address_id` string, uuid: ID of the shipping address. - `external_reference` string: A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity. - `language` 'ab' | 'aa' | 'af' | 'ak' | 'sq' | 'am' | 'ar' | 'an' | 'hy' | 'av' | 'ae' | 'ay' | 'az' | 'bm' | 'ba' | 'eu' | 'be' | 'bn' | 'bi' | 'bs' | 'br' | 'bg' | 'my' | 'ca' | 'ch' | 'ce' | 'ny' | 'zh' | 'cu' | 'cv' | 'kw' | 'co' | 'cr' | 'hr' | 'cs' | 'da' | 'dv' | 'nl' | 'dz' | 'en' | 'eo' | 'et' | 'ee' | 'fo' | 'fj' | 'fi' | 'fr' | 'fy' | 'ff' | 'gd' | 'gl' | 'lg' | 'ka' | 'de' | 'el' | 'kl' | 'gn' | 'gu' | 'ht' | 'ha' | 'he' | 'hz' | 'hi' | 'ho' | 'hu' | 'io' | 'ig' | 'id' | 'ia' | 'ie' | 'iu' | 'ik' | 'ga' | 'it' | 'ja' | 'jv' | 'kn' | 'kr' | 'ks' | 'kk' | 'km' | 'ki' | 'rw' | 'ky' | 'kv' | 'kg' | 'ko' | 'kj' | 'ku' | 'lo' | 'la' | 'lv' | 'li' | 'ln' | 'lt' | 'lu' | 'lb' | 'mk' | 'mg' | 'ms' | 'ml' | 'mt' | 'gv' | 'mi' | 'mr' | 'mh' | 'mn' | 'na' | 'nv' | 'nd' | 'nr' | 'ng' | 'ne' | 'no' | 'nb' | 'nn' | 'ii' | 'oc' | 'oj' | 'om' | 'os' | 'pi' | 'ps' | 'fa' | 'pl' | 'pt' | 'pa' | 'qu' | 'ro' | 'rm' | 'rn' | 'ru' | 'se' | 'sm' | 'sg' | 'sa' | 'sc' | 'sr' | 'sn' | 'sd' | 'si' | 'sk' | 'sl' | 'so' | 'st' | 'es' | 'su' | 'sw' | 'ss' | 'sv' | 'tl' | 'ty' | 'tg' | 'ta' | 'tt' | 'te' | 'th' | 'bo' | 'ti' | 'to' | 'ts' | 'tn' | 'tr' | 'tk' | 'tw' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'cy' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zu' - `organization` CounterpartOrganizationResponse, required: Represents counterparts that are organizations (juridical persons). - `email` string, email: The email address of the organization - `is_customer` boolean, required: Indicates if the counterpart is a customer. - `is_vendor` boolean, required: Indicates if the counterpart is a vendor. - `legal_name` string, required: The legal name of the organization. - `phone` string: The phone number of the organization - `tags` CounterpartTagSchema[]: The list of tags for this counterpart. - `id` string, uuid, required: A unique ID of this tag. - `created_at` string, date-time, required: Date and time when the tag was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. - `updated_at` string, date-time, required: Date and time when the tag was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. - `category` 'document_type' | 'department' | 'project' | 'cost_center' | 'vendor_type' | 'payment_method' | 'approval_status' - `created_by_entity_user_id` string, uuid: ID of the user who created the tag. - `description` string: The tag description. - `name` string, required: The tag name. - `reminders_enabled` boolean - `tax_id` string: The counterpart's taxpayer identification number or tax ID. - `type` 'individual' | 'organization', required - `next_pagination_token` string: A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). - `prev_pagination_token` string: A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). ## Other responses - `401`: The `Authorization` header is missing or contains an invalid or expired access token. See [Authentication](https://docs.monite.com/api/concepts/authentication) to learn how to authenticate API calls. - `403`: The specified access token does not have permissions to perform this operation. - `422`: Validation Error - `429`: API rate limit has been exceeded. Check the response headers for the rate limit information. --- [API](https://skmtc.dev/monite/apis/monite-2.md) - [All operations](https://skmtc.dev/monite/apis/monite-2/llms.txt) - [OpenAPI document](https://skmtc.dev/monite/apis/monite-2/revisions/4299ccf95edb?raw)