The tags API from Artashippinginc — 2 operation(s) for tags.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/artashippinginc:artashippinginc-tags-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: hello@arta.io
name: Arta
url: https://manual.arta.io/
description: The Arta Public API provides quote generation, transport booking, and tracking capabilities. Additionally the API enables Arta partner organizations to configure email and webhook notifications for their accounts.
termsOfService: https://www.arta.io/legal/terms
title: Arta Public Tags API
version: '2021-01-01'
servers:
- url: https://api.arta.io
variables: {}
security: []
tags:
- name: Tags
paths:
/tags:
get:
callbacks: {}
deprecated: false
description: 'Retrieve a paginated collection of tags belonging to your organization
Tags allow you to categorize and organize Shipments, Requests, and other resources for easier tracking and filtering. They can be created, updated, and archived by setting is_active to false. Archived tags remain linked to existing records but cannot be associated with new ones. If needed, tags can be reactivated later.
Tags are global for an organization and shared across both Live and Test modes.'
operationId: tags/list
parameters:
- description: Authorize your API calls with an Arta API token
example: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
in: header
name: Authorization
required: true
schema:
type: string
x-struct: null
x-validate: null
- description: Page number of the results to fetch.
in: query
name: page
schema:
default: 1
type: integer
x-struct: null
x-validate: null
- description: Results per page (max 50)
in: query
name: page_size
schema:
default: 20
type: integer
x-struct: null
x-validate: null
- description: 'An optional sort order for the returned collection.
Sorting is not applied to a request that also includes a `search` term. Those results are returned in order of relevance to the search.'
in: query
name: sort
required: false
schema:
enum:
- created_at_asc
- created_at_desc
- updated_at_asc
- updated_at_desc
type: string
x-struct: null
x-validate: null
- description: An optional structured search query
in: query
name: search
required: false
schema:
nullable: true
type: string
x-struct: null
x-validate: null
responses:
'200':
content:
application/json:
schema:
properties:
items:
items:
$ref: '#/components/schemas/Tag'
type: array
x-struct: null
x-validate: null
metadata:
properties:
page:
example: 1
format: int64
readOnly: true
type: integer
x-struct: null
x-validate: null
page_size:
example: 20
format: int64
readOnly: true
type: integer
x-struct: null
x-validate: null
total_count:
example: 1
format: int64
readOnly: true
type: integer
x-struct: null
x-validate: null
type: object
x-struct: null
x-validate: null
type: object
x-struct: null
x-validate: null
description: A collection of Tag records
headers:
content-type:
example: application/json
schema:
type: string
x-struct: null
x-validate: null
style: simple
x-arta-request-id:
description: A unique identifier for the Arta API call
example: FkBjuxbwLLTx4RoAARkx
schema:
type: string
x-struct: null
x-validate: null
style: simple
summary: List Tags
tags:
- Tags
post:
callbacks: {}
deprecated: false
description: Create a new tag for your organization.
operationId: tags/create
parameters:
- description: Authorize your API calls with an Arta API token
example: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
in: header
name: Authorization
required: true
schema:
type: string
x-struct: null
x-validate: null
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TagCreate'
required: false
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: The created tag
headers:
content-type:
example: application/json
schema:
type: string
x-struct: null
x-validate: null
style: simple
x-arta-request-id:
description: A unique identifier for the Arta API call
example: FkBjuxbwLLTx4RoAARkx
schema:
type: string
x-struct: null
x-validate: null
style: simple
'400':
content:
application/json:
schema:
properties:
errors:
properties:
detail:
example: string
type: string
x-struct: null
x-validate: null
type: object
x-struct: null
x-validate: null
title: BadRequest
type: object
x-struct: null
x-validate: null
description: Bad Request
headers:
content-type:
example: application/json
schema:
type: string
x-struct: null
x-validate: null
style: simple
x-arta-request-id:
description: A unique identifier for the Arta API call
example: FkBjuxbwLLTx4RoAARkx
schema:
type: string
x-struct: null
x-validate: null
style: simple
'403':
content:
application/json: {}
description: Forbidden
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unprocessible entity
summary: Create a Tag
tags:
- Tags
/tags/{tag_name}:
get:
callbacks: {}
deprecated: false
description: Retrieve an existing Tag resource by name
operationId: tags/get
parameters:
- description: Authorize your API calls with an Arta API token
example: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
in: header
name: Authorization
required: true
schema:
type: string
x-struct: null
x-validate: null
- description: The name field for a Tag resource
in: path
name: tag_name
required: true
schema:
type: string
x-struct: null
x-validate: null
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: Successful Tag response
headers:
content-type:
example: application/json
schema:
type: string
x-struct: null
x-validate: null
style: simple
x-arta-request-id:
description: A unique identifier for the Arta API call
example: FkBjuxbwLLTx4RoAARkx
schema:
type: string
x-struct: null
x-validate: null
style: simple
'404':
content:
application/json:
schema:
properties:
errors:
properties:
detail:
example: string
type: string
x-struct: null
x-validate: null
type: object
x-struct: null
x-validate: null
title: NotFound
type: object
x-struct: null
x-validate: null
description: Not Found
headers:
content-type:
example: application/json
schema:
type: string
x-struct: null
x-validate: null
style: simple
x-arta-request-id:
description: A unique identifier for the Arta API call
example: FkBjuxbwLLTx4RoAARkx
schema:
type: string
x-struct: null
x-validate: null
style: simple
summary: Get a Tag
tags:
- Tags
patch:
callbacks: {}
deprecated: false
description: Update an existing Tag resource
operationId: tags/update
parameters:
- description: Authorize your API calls with an Arta API token
example: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
in: header
name: Authorization
required: true
schema:
type: string
x-struct: null
x-validate: null
- description: The name field for a Tag resource
in: path
name: tag_name
required: true
schema:
type: string
x-struct: null
x-validate: null
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TagUpdate'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: The updated tag
headers:
content-type:
example: application/json
schema:
type: string
x-struct: null
x-validate: null
style: simple
x-arta-request-id:
description: A unique identifier for the Arta API call
example: FkBjuxbwLLTx4RoAARkx
schema:
type: string
x-struct: null
x-validate: null
style: simple
'404':
content:
application/json:
schema:
properties:
errors:
properties:
detail:
example: string
type: string
x-struct: null
x-validate: null
type: object
x-struct: null
x-validate: null
title: NotFound
type: object
x-struct: null
x-validate: null
description: Not Found
headers:
content-type:
example: application/json
schema:
type: string
x-struct: null
x-validate: null
style: simple
x-arta-request-id:
description: A unique identifier for the Arta API call
example: FkBjuxbwLLTx4RoAARkx
schema:
type: string
x-struct: null
x-validate: null
style: simple
summary: Update a Tag
tags:
- Tags
components:
schemas:
Error:
properties:
errors:
properties:
detail:
description: A human-readable explanation specific to this occurrence of the problem
type: string
x-struct: null
x-validate: null
type: object
x-struct: null
x-validate: null
title: Error
type: object
x-struct: Elixir.DocsWeb.Schemas.Response.Error
x-validate: null
TagUpdate:
additionalProperties: false
properties:
tag:
properties:
color:
description: The hexadecimal color code for the tag, without the leading `#`.
example: 0000FF
maxLength: 6
minLength: 6
pattern: ^[0-9A-F]{6}$
type: string
x-struct: null
x-validate: null
description:
description: An optional, brief description for this tag.
maxLength: 255
nullable: true
type: string
x-struct: null
x-validate: null
is_active:
description: Indicates whether or not the tag is active. Inactive tags may not be associated to new resources
nullable: true
type: boolean
x-struct: null
x-validate: null
name:
description: The name for the tag. It may contain lower case letters, dashes, and alphanumeric characters only. The maximum character count is 50.
example: la-warehouse
maxLength: 50
pattern: ^[a-z0-9-]{1,50}$
type: string
x-struct: null
x-validate: null
type: object
x-struct: null
x-validate: null
required:
- tag
title: TagUpdate
type: object
x-struct: Elixir.DocsWeb.Schemas.RequestBody.TagUpdate
x-validate: null
Tag:
example:
color: 008000
created_at: '2024-09-25T19:17:54.871490'
created_by: null
description: null
id: f7e4b35b-5131-47c2-9a88-238bd6e62e2d
is_active: false
name: ct-warehouse
updated_at: '2024-09-25T19:19:01.648283'
updated_by: null
properties:
color:
description: The hexadecimal color code for the tag, without the leading `#`.
example: 0000FF
maxLength: 6
minLength: 6
pattern: ^[0-9A-F]{6}$
type: string
x-struct: null
x-validate: null
created_at:
description: A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision
example: '2024-08-13T22:44:39.593704'
format: date-time
type: string
x-struct: null
x-validate: null
created_by:
description: The user ID associated with the user who created the tag when applicable.
format: int64
nullable: true
type: integer
x-struct: null
x-validate: null
description:
description: An optional, brief description for this tag.
maxLength: 255
nullable: true
type: string
x-struct: null
x-validate: null
id:
description: The id of the tag in UUID format
format: uuid
type: string
x-struct: null
x-validate: null
is_active:
description: Indicates whether or not the tag is active. Inactive tags may not be associated to new resources
type: boolean
x-struct: null
x-validate: null
name:
description: The name for the tag. It may contain lower case letters, dashes, and alphanumeric characters only. The maximum character count is 50.
example: la-warehouse
maxLength: 50
pattern: ^[a-z0-9-]{1,50}$
type: string
x-struct: null
x-validate: null
updated_at:
description: A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision
example: '2024-08-13T22:44:39.593704'
format: date-time
type: string
x-struct: null
x-validate: null
updated_by:
description: The user ID associated with the last user to edit the tag when applicable.
format: int64
nullable: true
type: integer
x-struct: null
x-validate: null
title: Tag
type: object
x-struct: Elixir.DocsWeb.Schemas.Response.Tag
x-validate: null
TagCreate:
additionalProperties: false
properties:
tag:
properties:
color:
description: The hexadecimal color code for the tag, without the leading `#`.
example: 0000FF
maxLength: 6
minLength: 6
pattern: ^[0-9A-F]{6}$
type: string
x-struct: null
x-validate: null
description:
description: An optional, brief description for this tag.
maxLength: 255
nullable: true
type: string
x-struct: null
x-validate: null
is_active:
description: Indicates whether or not the tag is active. Inactive tags may not be associated to new resources
nullable: true
type: boolean
x-struct: null
x-validate: null
name:
description: The name for the tag. It may contain lower case letters, dashes, and alphanumeric characters only. The maximum character count is 50.
example: la-warehouse
maxLength: 50
pattern: ^[a-z0-9-]{1,50}$
type: string
x-struct: null
x-validate: null
required:
- color
- name
type: object
x-struct: null
x-validate: null
required:
- tag
title: TagCreate
type: object
x-struct: Elixir.DocsWeb.Schemas.RequestBody.TagCreate
x-validate: null
x-topics:
- content: 'The Arta API accepts server-to-server communications authenticated by API keys. Your API keys are self-managed and unique to your organization.
Using your API key to authenticate an API call is straightforward. Simply include your API Key token in the Authorization header of every call made to the system. This is the only place that it is accepted.'
example: "```shell\n\n$ curl \\ \n\n -X GET https://api.arta.io/shipments \\ \n\n -H \"Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y\""
title: Authentication
- content: "Arta imposes rate limits on API requests to maintain system stability and ensure fair usage. If you exceed these limits, the API will return a `429 Too Many Requests` error. Below are the rate limits for both Live and Test modes.\n\n**Live Mode:**\n\n*\tConcurrent requests: 15 API calls at the same time (any type)\n* Instant quote requests: 20 calls per minute\n* Overall requests: 1000 API calls per minute (any type)\n\n**Test Mode:**\n\n* Concurrent requests: 10 API calls at the same time (any type)\n* Instant quote requests: 10 calls per minute\n* Overall requests: 500 API calls per minute (any type)\n\nWhen a rate limit is exceeded, we recommend implementing retry logic with exponential backoff to handle 429 errors effectively."
title: Rate Limits
- content: 'The Arta API supports flexible search functionality across multiple resources, including Shipments, Requests, Hosted Sessions, Tags, and others. Using the search query parameter, you can construct structured queries to filter results based on specific criteria.
Key features of the search functionality include:
* Support for negation, wildcards, numeric filters, and date comparisons.
* Each search query consists of one or more clauses, where each clause contains a `field`, an operator, and a `value`.
* Clauses operating on the same field are combined using OR logic, while clauses across different fields are combined using AND logic.
* Use quotation marks to keep multi-word search terms together.
This allows for powerful and precise filtering to retrieve the exact data you need from the API.
**Syntax and operators**
The following table lists the operators and syntax that you can use to construct a search query clause.
| Operator | Usage | Description | Examples |
|------------|--------------------------------|-----------------------------------------------------------------------------|---------------------------------------------------------------------|
| `:` | `field:value` | Exact match operator (case insensitive) | `status:pending` returns records where the status is `pending` |
| `*` | `value*` | Use an asterisk (wildcard operator) at the end of a term to match fields that start with the fragment | `art*` returns records that match "arta" and "artist" but not "smart" |
| `*` | `*value` | Use an asterisk at the start of a term to match fields that end with the fragment | `*art` returns "smart" but not "martian" |
| `-` | `-field:value` | Returns records that don’t match the clause | `-status:pending` returns records that do not have a status of pending |
| `>, <, =` | `field:<value`, `field:>value`, `field:>=value`, `field:<=value` | Greater than/less than operators | `created-at:<=2021-01-01` returns records from the beginning of time through January 1, 2021 |
| `..` | `field:value1..value2` | Filters for values within a given range where the first number is the lowest value and the second is the highest | `created-at:2021-05-01..2021-05-15` returns records where the `created_at` field is between May 1, 2021 and May 15, 2021 |
**Hosted Session search fields**
| Field | Type |
|------------|--------------|
| `created-at` | date |
| `destination-address-line-1` | string |
| `destination-city` | string |
| `destination-contacts-emails` | string |
| `destination-contacts-names` | string |
| `destination-contacts-phone-numbers` | string |
| `destination-country` | string |
| `destination-postal-code` | string |
| `destination-region` | string |
| `insurance` | string |
| `internal-reference` | string |
| `object-creators` | string |
| `object-descriptions` | string |
| `object-internal-references` | string |
| `object-public-references` | string |
| `object-titles` | string |
| `origin-address-line-1` | string |
| `origin-city` | string |
| `origin-contacts-emails` | string |
| `origin-contacts-names` | string |
| `origin-contacts-phone-numbers` | string |
| `origin-country` | string |
| `origin-postal-code` | string |
| `origin-region` | string |
| `public-reference` | string |
| `quote-type` | string |
| `shipping-notes` | string |
| `shortcode` | string |
| `status` | string |
| `type` | string |
| `tags` | string |
**Request search fields**
| Field | Type |
|------------|--------------|
| `bookable` | string |
| `created-at` | date |
| `destination-address-line-1` | string |
| `destination-city` | string |
| `destination-contacts-emails` | string |
| `destination-contacts-names` | string |
| `destination-contacts-phone-numbers` | string |
| `destination-country` | string |
| `destination-postal-code` | string |
| `destination-region` | string |
| `hosted-session` | string |
| `internal-reference` | string |
| `object-creators` | string |
| `object-descriptions` | string |
| `object-internal-references` | string |
| `object-public-references` | string |
| `object-titles` | string |
| `origin-address-line-1` | string |
| `origin-city` | string |
| `origin-contacts-emails` | string |
| `origin-contacts-names` | string |
| `origin-contacts-phone-numbers` | string |
| `origin-country` | string |
| `origin-postal-code` | string |
| `origin-region` | string |
| `public-reference` | string |
| `quote-type` | string |
| `shipping-notes` | string |
| `shortcode` | string |
| `status` | string |
| `tags` | string |
**Shipment search fields**
| Field | Type |
|------------|--------------|
| `created-at` | date |
| `destination-address-line-1` | string |
| `destination-city` | string |
| `destination-contacts-emails` | string |
| `destination-contacts-names` | string |
| `destination-contacts-phone-numbers` | string |
| `destination-country` | string |
| `destination-postal-code` | string |
| `destination-region` | string |
| `eei-form-status` | string |
| `hosted-session` | string |
| `internal-reference` | string |
| `object-creators` | string |
| `object-descriptions` | string |
| `object-internal-references` | string |
| `object-public-references` | string |
| `object-titles` | string |
| `origin-address-line-1` | string |
| `origin-city` | string |
| `origin-contacts-emails` | string |
| `origin-contacts-names` | string |
| `origin-contacts-phone-numbers` | string |
| `origin-country` | string |
| `origin-postal-code` | string |
| `origin-region` | string |
| `public-reference` | string |
| `quote-type` | string |
| `request-shortcode` | string |
| `shipping-notes` | string |
| `shortcode` | string |
| `status` | string |
| `tags` | string |
| `total` | numeric |
| `total-currency` | string |
| `tracking-numbers` | string |
**Tag search fields**
| Field | Type |
|------------|--------------|
| `color` | string |
| `description` | string |
| `is_active` | string |
| `name` | string |
'
title: Search