Skip to content
SendTruss

Get an event type

GET
/event-types/{name}
curl --request GET \
  --url https://api.sendtruss.com/v1/event-types/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required
string

Responses

Section titled “Responses”

200

Section titled “200”

EventTypeResource

Media typeapplication/json
object
data
required
EventTypeResource
object
name
required
string
fields
required
Array
created_at
required
string | null
updated_at
required
string | null
Examplegenerated
{
  "data": {
    "name": "example",
    "fields": [
      "example"
    ],
    "created_at": "example",
    "updated_at": "example"
  }
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

401

Section titled “401”

The API key is missing, malformed, revoked or expired.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: unauthenticated
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "unauthenticated"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

404

Section titled “404”

Nothing is at this path for your key. Another platform’s or another workspace’s resource answers the same as one that doesn’t exist.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: not_found
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "not_found"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

429

Section titled “429”

Too many requests. Wait for the seconds in Retry-After.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: rate_limited
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "rate_limited"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

Retry-After
integer

Seconds to wait before trying again.