Reference
What the ids and values in other answers mean.
GET /categories
The service category tree
Scope: listings:read, or the broad read.
Parents first, in the site's order; not paginated. Services (type 0) only.
Parameters
| Name | Where | Description |
|---|---|---|
If-None-Match | header | An ETag from an earlier response. |
Example request
curl "https://www.seoclerk.com/api/v1/categories" \
-H "Authorization: Bearer $SEOCLERKS_API_KEY"
Response 200
A page of these in data, with meta.limit and meta.next_cursor.
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string | |
slug | string | |
parent_id | integer or null | |
depth | integer | |
listing_count | integer | |
url | string |
{
"data": [
{
"id": 1024,
"name": "Example",
"slug": "string",
"parent_id": 1024,
"depth": 1,
"listing_count": 1,
"url": "https://www.seoclerk.com/example"
}
],
"meta": {
"request_id": "9f2c4e1ab07d3351"
}
}
Errors
| Status | Codes |
|---|---|
| 400 | https_required key_in_query |
| 401 | account_unavailable invalid_credentials key_expired key_revoked |
| 403 | missing_scope |
| 404 | not_found |
| 405 | method_not_allowed |
| 422 | invalid_parameter |
| 429 | rate_limited |
| 500 | internal_error |
GET /fee-schedule
What the site charges
Scope: balance:read, or the broad read.
The rates the site's own code charges.
Parameters
| Name | Where | Description |
|---|---|---|
If-None-Match | header | An ETag from an earlier response. |
Example request
curl "https://www.seoclerk.com/api/v1/fee-schedule" \
-H "Authorization: Bearer $SEOCLERKS_API_KEY"
Response 200
| Field | Type | Description |
|---|---|---|
commission | object | |
commission.percent | number | |
commission.level_discounts | list of object | |
commission.level_discounts[].seller_level | integer | |
commission.level_discounts[].seller_label | string | |
commission.level_discounts[].percent | number | |
commission.adds_affiliate_excess | boolean | |
commission.own_referral_percent | number | |
commission.own_referral_minimum | money | |
commission.description | string | |
direct_pay | object | |
direct_pay.percent | number | |
direct_pay.adds_affiliate_excess | boolean | |
direct_pay.invoiced_from | money | |
direct_pay.withdrawals_blocked_from | money | |
direct_pay.description | string | |
affiliate | object | |
affiliate.percent | number | |
affiliate.direct_pay_percent | number | |
affiliate.listing_minimum_percent | number | |
affiliate.listing_maximum_percent | number | |
affiliate.description | string | |
buyer_service_fee | object or null | |
buyer_service_fee.amount | money | |
buyer_service_fee.up_to | money | |
withdrawal_fee | null | No site fee. |
deposit_fee | null | No site fee. |
{
"data": {
"commission": {
"percent": 4.8,
"level_discounts": [
{}
],
"adds_affiliate_excess": true,
"own_referral_percent": 4.8,
"own_referral_minimum": {
"amount": "12.50",
"currency": "USD"
},
"description": "A short description."
},
"direct_pay": {
"percent": 4.8,
"adds_affiliate_excess": true,
"invoiced_from": {
"amount": "12.50",
"currency": "USD"
},
"withdrawals_blocked_from": {
"amount": "12.50",
"currency": "USD"
},
"description": "A short description."
},
"affiliate": {
"percent": 4.8,
"direct_pay_percent": 4.8,
"listing_minimum_percent": 4.8,
"listing_maximum_percent": 4.8,
"description": "A short description."
},
"buyer_service_fee": {
"amount": {
"amount": "12.50",
"currency": "USD"
},
"up_to": {
"amount": "12.50",
"currency": "USD"
}
},
"withdrawal_fee": "string",
"deposit_fee": "string"
},
"meta": {
"request_id": "9f2c4e1ab07d3351"
}
}
Errors
| Status | Codes |
|---|---|
| 400 | https_required key_in_query |
| 401 | account_unavailable invalid_credentials key_expired key_revoked |
| 403 | missing_scope |
| 404 | not_found |
| 405 | method_not_allowed |
| 422 | invalid_parameter |
| 429 | rate_limited |
| 500 | internal_error |
GET /order-statuses
What each order status means
Scope: orders:read, or the broad read.
Every value of an order's status; not paginated.
Parameters
| Name | Where | Description |
|---|---|---|
If-None-Match | header | An ETag from an earlier response. |
Example request
curl "https://www.seoclerk.com/api/v1/order-statuses" \
-H "Authorization: Bearer $SEOCLERKS_API_KEY"
Response 200
A page of these in data, with meta.limit and meta.next_cursor.
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string | |
description | string | |
final | boolean | A finished order cannot be acted on. |
{
"data": [
{
"id": 1024,
"name": "Example",
"description": "A short description.",
"final": true
}
],
"meta": {
"request_id": "9f2c4e1ab07d3351"
}
}
Errors
| Status | Codes |
|---|---|
| 400 | https_required key_in_query |
| 401 | account_unavailable invalid_credentials key_expired key_revoked |
| 403 | missing_scope |
| 404 | not_found |
| 405 | method_not_allowed |
| 422 | invalid_parameter |
| 429 | rate_limited |
| 500 | internal_error |