Skip to content
Artbucket

Reports and claims about your listings

GET
/api/v1/hub/reports
curl --request GET \
  --url http://localhost:3000/api/v1/hub/reports \
  --header 'Authorization: Bearer <token>'

About the organization’s BrandHub listings, open first, newest first, 200 at most. Organization admin.

Scope: admin.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Reports and claims

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required

Report: anyone’s word about a listing; claim: an organization that proved a domain or a GitHub account says the brand is its

string
Allowed values: report claim
reason
required

A report’s reason; claim for a claim

string
note
required
string | null
contact
required

How to reach who sent it, as they gave it; a claimant’s email

string | null
claimant
required
Any of:
object
name
required
string
proof
required

What it proved it holds: a domain, or github.com/{login}

string | null
status
required
string
Allowed values: open resolved
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
brand
required
object
slug
required
string
name
required
string
project
required
string
visibility
required
string
Allowed values: private public
Example
{
  "data": [
    {
      "kind": "report",
      "status": "open",
      "brand": {
        "visibility": "private"
      }
    }
  ]
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}