IMPORTANT
THE URL BASE PATH IS THE FOLLOWING:
https://www.app.tattoogenda.com/api/
In the list below you can find all our available endpoints.
These endpoints will BE ADDED TO THIS BASE PATH
( e.g. https://www.app.tattoogenda.com/api/shop/byId/SHOPID )
NOTES
Only ACTIVE artists will show into your responses.
SHOP
Shows you your shops information.
YOU WILL NEED THE FOLLOWING INFORMATION
API KEY, Shop ID
SHOWS YOU YOUR SHOPS INFORMATION
shop/byId/SHOPID
( e.g. shop/byId/103 )
This endpoint is a GET request
AN EXAMPLE OF A RESPONSE
{
"name": "INK STORIES",
"email": "sharice.vandenhende@student.howest.be"
}
For more information or questions regarding endpoints contact sandy@tattoogenda.com.
GENRES
Genres of your shop are defined by the selected genres when an artist is created.
You might need these genre id’s for your shop for some of our endpoints.
YOU WILL NEED THE FOLLOWING INFORMATION
API KEY, Shop ID
SHOW GENRES AVAILABLE INTO YOUR SHOP
genres/byId/SHOPID
( e.g. genres/byId/103 )
This endpoint is a GET request
AN EXAMPLE OF A RESPONSE
{
"genres": [
{
"id": 1,
"name": "Old school",
"name_fr": "Old school",
"name_nl": "Old school",
"customVisionId": "ffd5f772-f7ff-4f91-9f81-335392774b3e",
"image": ""
}
]
}
For more information or questions regarding endpoints contact sandy@tattoogenda.com.
ARTIST
These endpoints will give more information about a certain artist into your shop.
This could be information, available dates,…
YOU WILL NEED THE FOLLOWING INFORMATION
API KEY, Shop ID, ARTIST ID, TYPE
TYPE VARIABLES
GUEST_ARTIST, RESIDENT_ARTIST, ALL
SHOWS MORE INFORMATION ABOUT A SPECIFIC ARTIST
artist/byId/ARTISTID-SHOPID
( e.g. artist/byId/clgm2dige0030nu1r4j4xphfo-103 )
This endpoint is a GET request
AN EXAMPLE OF A RESPONSE
{
"name": "Leyla Smith"
}
SHOW A SPECIFIC ARTIST FIRST AVAILABLE DATES
artist/calendar/ARTISTID-SHOPID
( e.g. artist/calendar/clgm2dige0030nu1r4j4xphfo-103 )
This endpoint is a GET request
AN EXAMPLE OF A RESPONSE
{
"name": "Leyla Smith",
"shops": [
{
"shopName": "INK STORIES",
"firstFreeDates": [
"Wed 30/8",
"Thu 31/8",
"Fri 1/9",
"Sat 2/9",
"Tue 5/9",
"Wed 6/9",
"Thu 7/9",
"Fri 8/9",
"Sat 9/9",
"Tue 12/9"
]
}
]
}
SHOW BOOKABLE DATES OF A SPECIFIC ARTIST
artist/bookableDates/byArtistIdShopId/ARTISTID-SHOPID
( e.g. artist/bookableDates/byArtistIdShopId/clgm2dige0030nu1r4j4xphfo-103 )
This endpoint is a GET request
AN EXAMPLE OF A RESPONSE
{
"freeDates": [
"Wed 30/8",
"Thu 31/8",
"Fri 1/9",
"Sat 2/9",
"Tue 5/9",
"Wed 6/9",
"Thu 7/9",
"Fri 8/9",
"Sat 9/9",
"Tue 12/9",
"Wed 13/9",
"Thu 14/9",
"Fri 15/9",
"Sat 16/9",
]
}
SHOW ARTISTS FILTERED BY GENRE AND TYPE OF ARTIST
artist/byFilter/GENREID-SHOPID-TYPE
( e.g. artist/byFilter/5-103-GUEST_ARTIST )
This endpoint is a GET request
AN EXAMPLE OF A RESPONSE
{
"shops": [
{
"shopName": "INK STORIES",
"Artists": [
{
"firstname": "Simon",
"lastName": "McFaun",
"role": "GUEST_ARTIST",
"picture": "https://ucarecdn.com/6b1c008c-aac9-40e2-be02-8a85a1902c30/",
"freeDates": [
"Wed 30/8",
"Thu 31/8",
"Fri 1/9",
"Sat 2/9",
"Tue 5/9"
]
}
]
}
]
}
SHOW ALL ARTISTS FILTERED BY GENRE AND TYPE OF ARTIST
artist/byFilter/GENREID-SHOPID-TYPE
( e.g. artist/byFilter/5-103-ALL)
This endpoint is a GET request
AN EXAMPLE OF A RESPONSE
{
"shops": [
{
"shopName": "INK STORIES",
"Artists": [
{
"firstname": "Raymond",
"lastName": "Dupond",
"role": "RESIDENT_ARTIST",
"picture": "https://ucarecdn.com/6b1c008c-aac9-8402-be02-8a85a1902c30/",
"freeDates": [
"Wed 18/9",
"Thu 31/10",
"Fri 1/12",
"Sat 2/12",
"Tue 5/12"
]
},
{
"firstname": "Simon",
"lastName": "McFaun",
"role": "GUEST_ARTIST",
"picture": "https://ucarecdn.com/6b1c008c-aac9-40e2-be02-8a85a1902c30/",
"freeDates": [
"Wed 30/8",
"Thu 31/8",
"Fri 1/9",
"Sat 2/9",
"Tue 5/9"
]
}
]
}
]
}
For more information or questions regarding endpoints contact sandy@tattoogenda.com.
BOOKINGS
This endpoint will help you with making bookings from your custom website into tattoogenda.
MAKE A BOOKING DIRECTLY INTO TATTOOGENDA
/booking/save
( e.g. /booking/save)
The bookings endpoint is a POST.
A Booking needs certain information before it can be saved.
We pass the booking on the following endpoint with the following information in a JSON format.
{
“customer“:{
“firstName“:”12345”,
“lastName“:”12354”,
“email“:”12354@1345.com”,
“phone“:”13245”,
“postalCode“:”12354”
},
“tattooProject“:{
“tattooSize“:”large”,
“tattooSubject“:”Butterfly on arm”,
“longDescriptionSummary“:”The customer wants a butterfly, in color, on the hip. with some curly details and a name. it’s a tattoo for my wife.”,
“colorOrBlackAndWhite“:”Black and white with blue details”,
“tattooGenre“:”Fine-line”,
“placementOnTheBody“:”Arm outside lower arm”,
“inputByCustomer“:”more stuff they mentioned that you can not put anywhere else here”,
“extraUpdateFromCustomer“:”what the customer later added to his inital request”,
“attachments“:[],
“price“:”100€”
},
“artistId“:”clb6e2qh40007r221ebzlmx75”,
“bookedDates“:[{“date“:”15-8-2023″,”startTime“:”12:00″,”endTime“:”19:00”}],
“shopId“:35
}
For more information or questions regarding endpoints contact sandy@tattoogenda.com.
You still have a problem or a question?
You can find a little link below called ‘Still stuck? How can we help!’
Written by
Sharice Vandenhende
By Tattoogenda
