Attorneys API (1.0.0)

Download OpenAPI specification:Download

Houses and maintains attorneys data.

Attorney

Create an Attorney

Authorizations:

X-Api-Token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Request Body schema: application/json
required

userId required	string <uuid>
lawFirmName required	string
email	string or null <email>
image	string or null <url>
biography	string or null
required	object
isCrtMember required	boolean
isSearchable required	boolean

Responses

Request samples

Payload

Content type

application/json

{"userId": "fb44dba7-5329-4994-9eb4-69b2996e6279",
"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true
}

Response samples

201
401
406
415
422

Content type

application/json

{"data": {"type": "attorneys",
"id": "fb44dba7-5329-4994-9eb4-69b2996e6279",
"attributes": {"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true,
"isActivated": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Fetch a paginated list of Attorneys

Authorizations:

X-Api-Token

query Parameters

sortBy	string Example: sortBy=foo
sort	string Example: sort=desc
perPage	integer Example: perPage=50
page	integer Example: page=1
filter[attribute][_eq]	string Example: filter[attribute][_eq]=foo
filter[attribute][_neq]	string Example: filter[attribute][_neq]=foo
filter[attribute][_lt]	string Example: filter[attribute][_lt]=2023-01-01 00:00:00
filter[attribute][_lte]	string Example: filter[attribute][_lte]=2023-01-01 00:00:00
filter[attribute][_gt]	string Example: filter[attribute][_gt]=2023-01-01 00:00:00
filter[attribute][_gte]	string Example: filter[attribute][_gte]=2023-01-01 00:00:00
filter[attribute][_in][]	string Example: filter[attribute][_in][]=foo
filter[attribute][_nin][]	string Example: filter[attribute][_nin][]=foo
filter[attribute][_starts_with]	string Example: filter[attribute][_starts_with]=foo
filter[attribute][_ends_with]	string Example: filter[attribute][_ends_with]=foo
filter[attribute][_contains]	string Example: filter[attribute][_contains]=foo
filter[relationship][_has][column][_filter]	string Example: filter[relationship][_has][column][_filter]=foo
include[]	string Value: "locations"

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Responses

Response samples

200
401
406
422

Content type

application/json

{"links": {"self": "/attorneys?page=1",
"first": "/attorneys?page=1",
"next": null,
"previous": null,
"last": "/attorneys?page=1"
},
"data": [{"type": "attorneys",
"id": "fb44dba7-5329-4994-9eb4-69b2996e6279",
"attributes": {"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true,
"isActivated": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
],
"meta": {"total": 100,
"count": 10,
"perPage": 10,
"currentPage": 1,
"totalPages": 10
}
}

Retrieve an Attorney

Authorizations:

X-Api-Token

path Parameters

id

required

string <uuid>

Example: 9fbba405-570e-4ea8-93bf-b52426db101f

query Parameters

include[]

string

Value: "locations"

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Responses

Response samples

200
401
404
406
415

Content type

application/json

{"data": {"type": "attorneys",
"id": "fb44dba7-5329-4994-9eb4-69b2996e6279",
"attributes": {"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true,
"isActivated": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Update an Attorney

Authorizations:

X-Api-Token

path Parameters

id

required

string <uuid>

Example: 9fbba405-570e-4ea8-93bf-b52426db101f

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Request Body schema: application/json
required

lawFirmName	string
email	string or null <email>
image	string or null <url>
biography	string or null
	object
isCrtMember	boolean
isSearchable	boolean

Responses

Request samples

Payload

Content type

application/json

{"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true
}

Response samples

Content type

application/json

{"data": {"type": "attorneys",
"id": "fb44dba7-5329-4994-9eb4-69b2996e6279",
"attributes": {"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true,
"isActivated": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Deactivate an Attorney

Authorizations:

X-Api-Token

path Parameters

id

required

string <uuid>

Example: 9fbba405-570e-4ea8-93bf-b52426db101f

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Responses

Response samples

200
401
404
406
415

Content type

application/json

{"data": {"type": "attorneys",
"id": "fb44dba7-5329-4994-9eb4-69b2996e6279",
"attributes": {"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true,
"isActivated": false,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Reactivate an Attorney

Authorizations:

X-Api-Token

path Parameters

id

required

string <uuid>

Example: 9fbba405-570e-4ea8-93bf-b52426db101f

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Responses

Response samples

200
401
404
406
415

Content type

application/json

{"data": {"type": "attorneys",
"id": "fb44dba7-5329-4994-9eb4-69b2996e6279",
"attributes": {"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true,
"isActivated": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Attorney Location

Create an Attorney's Location

Authorizations:

X-Api-Token

path Parameters

id

required

string <uuid>

Example: 9fbba405-570e-4ea8-93bf-b52426db101f

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Request Body schema: application/json
required

phone required	string <phone> ^([0-9]{3})[-]([0-9]{3})[-]([0-9]{4})$
website	string or null <url>
required	object
lat required	string <coordinate>
lng required	string <coordinate>
isPrimary required	boolean

Responses

Request samples

Payload

Content type

application/json

{"phone": "765-123-4567",
"website": "https://www.attorney.com/",
"address": {"address": "1000 Freedom Way",
"address2": "",
"city": "West Bend",
"state": "WI",
"postalCode": "53095",
"country": "US"
},
"lat": "12.3456",
"lng": "98.7654",
"isPrimary": true
}

Response samples

Content type

application/json

{"data": {"type": "locations",
"id": "f3ecd751-72df-4e59-ba8a-b5cbec15cfdc",
"attributes": {"phone": "765-123-4567",
"website": "https://www.attorney.com/",
"address": {"address": "1000 Freedom Way",
"address2": "",
"city": "West Bend",
"state": "WI",
"postalCode": "53095",
"country": "US"
},
"lat": "12.3456",
"lng": "98.7654",
"isPrimary": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Retrieve an Attorney's Locations

Authorizations:

X-Api-Token

path Parameters

id

required

string <uuid>

Example: 9fbba405-570e-4ea8-93bf-b52426db101f

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Responses

Response samples

200
401
404
406
415

Content type

application/json

{"data": [{"type": "locations",
"id": "f3ecd751-72df-4e59-ba8a-b5cbec15cfdc",
"attributes": {"phone": "765-123-4567",
"website": "https://www.attorney.com/",
"address": {"address": "1000 Freedom Way",
"address2": "",
"city": "West Bend",
"state": "WI",
"postalCode": "53095",
"country": "US"
},
"lat": "12.3456",
"lng": "98.7654",
"isPrimary": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
]
}

Retrieve an Attorney's Primary Location

Authorizations:

X-Api-Token

path Parameters

id

required

string <uuid>

Example: 9fbba405-570e-4ea8-93bf-b52426db101f

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Responses

Response samples

200
401
404
406
415

Content type

application/json

{"data": {"type": "locations",
"id": "f3ecd751-72df-4e59-ba8a-b5cbec15cfdc",
"attributes": {"phone": "765-123-4567",
"website": "https://www.attorney.com/",
"address": {"address": "1000 Freedom Way",
"address2": "",
"city": "West Bend",
"state": "WI",
"postalCode": "53095",
"country": "US"
},
"lat": "12.3456",
"lng": "98.7654",
"isPrimary": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Retrieve an Attorney's Location

Authorizations:

X-Api-Token

path Parameters

id required	string <uuid> Example: 9fbba405-570e-4ea8-93bf-b52426db101f
location-id required	string <uuid> Example: f70b845b-3a6a-4aac-a8df-a01d164ba74e

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Responses

Response samples

200
401
404
406
415

Content type

application/json

{"data": {"type": "locations",
"id": "f3ecd751-72df-4e59-ba8a-b5cbec15cfdc",
"attributes": {"phone": "765-123-4567",
"website": "https://www.attorney.com/",
"address": {"address": "1000 Freedom Way",
"address2": "",
"city": "West Bend",
"state": "WI",
"postalCode": "53095",
"country": "US"
},
"lat": "12.3456",
"lng": "98.7654",
"isPrimary": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Update an Attorney's Location

Authorizations:

X-Api-Token

path Parameters

id required	string <uuid> Example: 9fbba405-570e-4ea8-93bf-b52426db101f
location-id required	string <uuid> Example: f70b845b-3a6a-4aac-a8df-a01d164ba74e

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Request Body schema: application/json
required

phone	string <phone> ^([0-9]{3})[-]([0-9]{3})[-]([0-9]{4})$
website	string or null <url>
	object
lat	string <coordinate>
lng	string <coordinate>
isPrimary	boolean

Responses

Request samples

Payload

Content type

application/json

{"phone": "765-123-4567",
"website": "https://www.attorney.com/",
"address": {"address": "1000 Freedom Way",
"address2": "",
"city": "West Bend",
"state": "WI",
"postalCode": "53095",
"country": "US"
},
"lat": "12.3456",
"lng": "98.7654",
"isPrimary": true
}

Response samples

Content type

application/json

{"data": {"type": "locations",
"id": "f3ecd751-72df-4e59-ba8a-b5cbec15cfdc",
"attributes": {"phone": "765-123-4567",
"website": "https://www.attorney.com/",
"address": {"address": "1000 Freedom Way",
"address2": "",
"city": "West Bend",
"state": "WI",
"postalCode": "53095",
"country": "US"
},
"lat": "12.3456",
"lng": "98.7654",
"isPrimary": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Delete an Attorney's Location

Authorizations:

X-Api-Token

path Parameters

id required	string <uuid> Example: 9fbba405-570e-4ea8-93bf-b52426db101f
location-id required	string <uuid> Example: f70b845b-3a6a-4aac-a8df-a01d164ba74e

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Api-Token required	string Example: d5c70e5d-6190-4ea9-a3ab-cc1c105cc0ee

Responses

Response samples

401
404
406
415
422

Content type

application/json

{"errors": [{"status": 401,
"title": "Unauthorized",
"detail": "The API token is missing or invalid."
}
]
}

User Attorney Preference

Create a User's Attorney Preference

Authorizations:

X-Api-Token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Auth-Token required	string Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiI5MmY5ZDhjOC00Njc5LTExZWQtYjE2YS0wMjQyMGEwMDAxM2QiLCJqdGkiOiIzYjgwYjBkMC1jOWMzLTExZWQtOWIxOS0wMjQyMGEwMDAzNzciLCJpc3MiOiJodHRwczpcL1wvaWQuZGV2LnVzY2NhLmNsb3VkIiwiaWF0IjoxNjc5NjA3NTg3LCJleHAiOjE2Nzk2NTA3ODd9.mntZ_0KGPIfzWKZdNbdLXvYOE26MK3-OJxukqfMxJkQ

Request Body schema: application/json
required

attorneyId

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"attorneyId": "fb44dba7-5329-4994-9eb4-69b2996e6279"
}

Response samples

201
401
406
415
422

Content type

application/json

{"data": {"type": "attorneys",
"id": "fb44dba7-5329-4994-9eb4-69b2996e6279",
"attributes": {"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true,
"isActivated": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Retrieve a User's Attorney Preference

Authorizations:

X-Api-Token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Auth-Token required	string Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiI5MmY5ZDhjOC00Njc5LTExZWQtYjE2YS0wMjQyMGEwMDAxM2QiLCJqdGkiOiIzYjgwYjBkMC1jOWMzLTExZWQtOWIxOS0wMjQyMGEwMDAzNzciLCJpc3MiOiJodHRwczpcL1wvaWQuZGV2LnVzY2NhLmNsb3VkIiwiaWF0IjoxNjc5NjA3NTg3LCJleHAiOjE2Nzk2NTA3ODd9.mntZ_0KGPIfzWKZdNbdLXvYOE26MK3-OJxukqfMxJkQ

Responses

Response samples

200
401
404
406
415

Content type

application/json

{"data": {"type": "attorneys",
"id": "fb44dba7-5329-4994-9eb4-69b2996e6279",
"attributes": {"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true,
"isActivated": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Update a User's Attorney Preference

Authorizations:

X-Api-Token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Auth-Token required	string Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiI5MmY5ZDhjOC00Njc5LTExZWQtYjE2YS0wMjQyMGEwMDAxM2QiLCJqdGkiOiIzYjgwYjBkMC1jOWMzLTExZWQtOWIxOS0wMjQyMGEwMDAzNzciLCJpc3MiOiJodHRwczpcL1wvaWQuZGV2LnVzY2NhLmNsb3VkIiwiaWF0IjoxNjc5NjA3NTg3LCJleHAiOjE2Nzk2NTA3ODd9.mntZ_0KGPIfzWKZdNbdLXvYOE26MK3-OJxukqfMxJkQ

Request Body schema: application/json
required

attorneyId

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"attorneyId": "fb44dba7-5329-4994-9eb4-69b2996e6279"
}

Response samples

Content type

application/json

{"data": {"type": "attorneys",
"id": "fb44dba7-5329-4994-9eb4-69b2996e6279",
"attributes": {"lawFirmName": "Test Law Firm, LLC",
"email": "email@attorney.com",
"image": "https://www.test.com/test.png",
"biography": "This is the attorney's biography.",
"socialLinks": {"facebook": "https://www.facebook.com/link",
"twitter": "https://www.twitter.com/link"
},
"isCrtMember": false,
"isSearchable": true,
"isActivated": true,
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Delete a User's Attorney Preference

Authorizations:

X-Api-Token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"
X-Auth-Token required	string Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiI5MmY5ZDhjOC00Njc5LTExZWQtYjE2YS0wMjQyMGEwMDAxM2QiLCJqdGkiOiIzYjgwYjBkMC1jOWMzLTExZWQtOWIxOS0wMjQyMGEwMDAzNzciLCJpc3MiOiJodHRwczpcL1wvaWQuZGV2LnVzY2NhLmNsb3VkIiwiaWF0IjoxNjc5NjA3NTg3LCJleHAiOjE2Nzk2NTA3ODd9.mntZ_0KGPIfzWKZdNbdLXvYOE26MK3-OJxukqfMxJkQ

Responses

Response samples

401
404
406
415

Content type

application/json

{"errors": [{"status": 401,
"title": "Unauthorized",
"detail": "An authenticated user is required to proceed."
}
]
}

Attorneys API (1.0.0)

Attorney

Create an Attorney

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Fetch a paginated list of Attorneys

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Retrieve an Attorney

Authorizations:

path Parameters

query Parameters

header Parameters

Responses

Response samples

Update an Attorney

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Deactivate an Attorney

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Reactivate an Attorney

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Attorney Location

Create an Attorney's Location

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve an Attorney's Locations

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Retrieve an Attorney's Primary Location

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Retrieve an Attorney's Location

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update an Attorney's Location

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an Attorney's Location

Authorizations:

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required